Skip to main content

LumenToml

Struct LumenToml 

Source
pub struct LumenToml {
Show 19 fields pub raw: Table, pub app: AppCfg, pub pages: PagesCfg, pub window: WindowCfg, pub skin: SkinCfg, pub mcp: McpCfg, pub profile: ProfileCfg, pub asset_roots: AssetRootsCfg, pub script: ScriptCfg, pub render: RenderCfg, pub perf: PerfCfg, pub runtime: RuntimeCfg, pub capabilities: CapabilitiesCfg, pub web: WebCfg, pub hooks: Vec<HookCfg>, pub plugins: Vec<Value>, pub dependencies: DependenciesCfg, pub target: TargetTables, pub signals: SignalsCfg,
}
Expand description

Parsed lumen.toml config, all fields optional.

Fields§

§raw: Table

The whole file, parsed but untyped. What an optional subsystem reads its own section from: the typed fields above are the runtime’s, and a subsystem the runtime does not name has no field here.

§app: AppCfg

[app] section.

§pages: PagesCfg

[pages] section - file-based multi-page navigation config.

§window: WindowCfg

[window] section.

§skin: SkinCfg

[skin] section.

§mcp: McpCfg

[mcp] section.

§profile: ProfileCfg

[profile] section.

§asset_roots: AssetRootsCfg

[asset_roots] section.

§script: ScriptCfg

[script] section - script-engine selection.

§render: RenderCfg

[render] section - which render backend draws the app.

§perf: PerfCfg

[perf] section - per-cache memory budgets.

§runtime: RuntimeCfg

[runtime] section - subsystem init overrides (MCP / hot-reload / thread budget).

§capabilities: CapabilitiesCfg

[capabilities] section - per-app COMPILE-TIME subsystem trim toggles for the static --bundle build (Part B tree-shaking).

§web: WebCfg

[web] section - how lumenc web emits the app as a static site.

§hooks: Vec<HookCfg>

[[hooks]] array - project-declared build/setup commands, run at the prebuild / prerun trigger points by lumenc run / build / bundle. See crate::hooks for the execution semantics (ordering, OS filtering, staleness skip) and HookCfg for the field reference.

§plugins: Vec<Value>

[[plugins]] array - compiler plugins, run in declaration order by every compile path, check included. This field only accepts the array (deny_unknown_fields would otherwise reject any app declaring one); nothing reads it. The schema, the loader, and the validation live in lumenc-plugin (see its PluginCfg), lumenc reads the file itself, and the chain reaches the pipeline through the injected crate::compiler_plugins::CompilerPlugins boundary, the same inversion the parser uses.

§dependencies: DependenciesCfg

[dependencies] table - prebuilt dylibs loaded at startup in sorted-name order: engine-linked runtime modules and portable C-ABI plugins, told apart by their exports. The schema, the loader, and the failure policy live in lumen-modules (re-exported as crate::modules); build_app runs the table through the loader when the modules feature is on.

§target: TargetTables

[target.web] and [target.desktop]: what a build for one target adds. Each may carry a dependencies table of the same shape as [dependencies], laid over it for that target’s builds; read the combined table through Self::dependencies_for.

§signals: SignalsCfg

[signals] table - optional typed schema. Each key declares the expected SignalType. Used by lumenc lint --signals to flag untyped writes / schema mismatches. Schema entries are optional: missing keys just downgrade the lint severity.

Implementations§

Source§

impl LumenToml

Source

pub fn load_or_default(dir: &Path) -> Result<Self, ConfigError>

Loads <dir>/lumen.toml when present and returns the parsed config; returns Self::default when the file is absent.

Source

pub fn dependencies_for(&self, target: Target) -> DependenciesCfg

The dependencies a build for target takes: [dependencies], with [target.<name>.dependencies] laid over it entry by entry.

Source

pub fn resolved_asset_roots(&self, dir: &Path) -> Vec<PathBuf>

Returns [asset_roots].paths resolved against dir, leaving absolute entries unchanged and joining relative entries onto dir.

Trait Implementations§

Source§

impl Clone for LumenToml

Source§

fn clone(&self) -> LumenToml

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LumenToml

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for LumenToml

Source§

fn default() -> LumenToml

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for LumenToml

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromTemplate for T
where T: Clone + Default + Unpin,

§

type Template = T

The [Template] for this type.
§

impl<T> FromWorld for T
where T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using default().

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

§

impl<T> Template for T
where T: Clone + Default + Unpin,

§

type Output = T

The type of value produced by this [Template].
§

fn build_template( &self, _context: &mut TemplateContext<'_, '_>, ) -> Result<<T as Template>::Output, BevyError>

Uses this template and the given entity context to produce a [Template::Output].
§

fn clone_template(&self) -> T

Clones this template. See Clone.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,