Struct InkLoader 

pub struct InkLoader {
    pub override_config: Option<ProjectConfig>,
}

Asset loader for .ink (source) files.

Reads the entry source, walks the INCLUDE graph asynchronously through Bevy’s AssetReader, lands the drained sources in a brink_source_tree::InMemory tree, then goes through the brink_environment producer: Project::load resolves brink.toml and override precedence and freezes an Environment, and brink_environment::compile compiles it. Links the result via brink_runtime::link and emits labeled subassets (#program, #line_tables) just like InkbLoader.

brink.toml discovery (#1029, #1360, #1406, #1439)

A brink.toml beside (or above) the entry asset supplies the ProjectConfig (dialect/types) that gates T1b brink-extension syntax — the same file the CLI discovers by walking the real filesystem (brink-project-config::load_from_entry). Bevy’s AssetReader may be virtual or packed, so load probes for it over the async reader itself: brink.toml beside the entry, then each ancestor directory in turn (nearest first), via LoadContext::read_asset_bytes — bounded at the asset source root (never above it) and naturally finite (the entry path has finitely many /-separated ancestors). As of #1439, [probe_brink_toml] stops at the first candidate it finds — the nearest one, since the walk is nearest-first — so only that candidate is ever read or registered as a load dependency; a farther, shadowed brink.toml is never fetched, so editing one in dev mode no longer triggers a hot-reload. The candidate’s text is landed at its own key in the drained source map; parsing it and applying CLI/API > file > default precedence is Project::load’s job (brink_project_config::discover_from_entry_in_tree over the same map, walking the same bounded ancestor chain again over whatever the map contains) — this loader only supplies candidate bytes, it does not re-implement the resolution policy. Because the probe already stops at the nearest hit, Project::load’s walk finds at most one candidate in practice, but it is still the one place that applies the precedence rule; the probe is, deliberately, back to being a second “which candidate is nearest” decider (the duplication #1406 removed and #1439 reintroduced on purpose, for the perf win — see [probe_brink_toml]’s doc). The two decisions agree by construction today because both walk [ancestor_dirs]-equivalent nearest-first order over the same bounded chain, but they are two independent implementations: a future change to brink-project-config’s bound/precedence shape would need to be mirrored here to stay honored on this path. A miss at every level leaves AnalysisOptions at its default — byte-identical to pre-#1029 behavior.

override_config, set via BrinkPlugin::with_config / BrinkAssetsPlugin::with_config, is the programmatic escape hatch: when set, its fields win over whatever brink.toml supplies — passed through as OptionOverrides, the same explicit call always wins over the file precedence Project::load applies for every mount (CLI included).

Fields

override_config: Option<ProjectConfig>

Out-of-band ProjectConfig override (#1029). None (the default) means “the discovered brink.toml asset (if any) wins”; Some fields win over the asset’s, unset fields still fall through to whatever the asset (or the built-in default) supplies.

Trait Implementations

impl AssetLoader for InkLoader

type Asset = BrinkStoryAsset

The top level Asset loaded by this AssetLoader.

type Settings = ()

The settings type used by this AssetLoader.

type Error = InkLoaderError

The type of error which could be encountered by this loader.

async fn load( &self, reader: &mut dyn Reader, _settings: &Self::Settings, load_context: &mut LoadContext<'_>, ) -> Result<Self::Asset, Self::Error>

Asynchronously loads AssetLoader::Asset (and any other labeled assets) from the bytes provided by Reader.

fn extensions(&self) -> &[&str]

Returns a list of extensions supported by this AssetLoader, without the preceding dot. Note that users of this AssetLoader may choose to load files with a non-matching extension.

impl Default for InkLoader

fn default() -> InkLoader

Returns the “default value” for a type.

impl TypePath for InkLoader

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.