Inno.Assets.Pipeline
Section titled “Inno.Assets.Pipeline”
- Authoring imports, source identities, settings, immutable artifacts and runtime export.
Inno.Assets.Pipeline owns the authoring side of asset processing: source mounts, filesystem discovery, importers, build processors, metadata sidecars, the rebuildable catalog and content-addressed artifacts. Player runtime code consumes exported content instead of referencing this pipeline.
Use the asset task guide to load source assets, edit import settings, import plugin samples or diagnose a failed export. Asset publication explains the transaction model.
Authoring ownership contract
Section titled “Authoring ownership contract”The host initializes and owns one pipeline with its type catalog, serialization registry, identity allocator and shared generation coordinator. Mutations run on the constructing owner thread inside a complete generation operation scope. A normal asynchronous continuation does not imply that it resumed on this thread.
Reconcile a dirty catalog before capturing the active loader. Type or serializer queries during an admitted operation defer automatic refresh; they cannot retire the loader still executing on the call stack. Pending or faulted generation state does not permit new export or publication work.
Source mounts and their dependencies are immutable snapshots. The current source’s .imeta sidecar determines which persistent ID owns a path; the catalog is a rebuildable index and artifact cache. A stale catalog entry cannot overwrite a newer sidecar identity during startup. Reusing a path without its original metadata does not restore the old identity.
Publication and failure contract
Section titled “Publication and failure contract”Source candidates remain isolated until activation. Metadata writes are staged; completion validates the original sidecar bytes, writes changes and promotes the catalog. Failure compensates already written files in reverse order, preserving both the original error and any recovery error. This is an owner-safe-point transaction with filesystem compensation, not a multi-file crash-atomic guarantee.
Source-mount activation publishes candidate identity and neutral reference recovery. Completion retires the old loader; rollback restores the unchanged former canonical objects and retires the candidate. Pending retirement retains all dependencies. A faulted generation requires host restart rather than continued access through partly retired services.
Last-good authoring content, current import diagnostics and successful Player export are distinct states. Required stale, failed or missing dependencies reject runtime export with their dependency path. Export does not reimport midway through an already selected generation.
Artifact and export contract
Section titled “Artifact and export contract”Artifact keys use complete 64-character SHA-256 identities. Output names and leaf filenames are unique; lengths and hashes are validated. TryGetArtifact checks metadata and lengths; payload reads and export also check actual content hashes. Same-length changes or preserved timestamps are not proof of freshness.
Named outputs can be Runtime or AuthoringOnly; reserved runtime and asset-state outputs cannot be authoring-only. Export validates and projects only runtime outputs to a new content-addressed key, cloning deployment metadata through the owner’s serializer. It does not rewrite the source catalog or sidecars and does not require asset-type-specific cases.
Background export retains the captured immutable serialization generation and its strict read lease until the worker has completed, failed or canceled. Callers cannot release the generation after merely scheduling the task.
API reference
Section titled “API reference”Authoring types and member contracts cover pipeline/loader access, imports, settings, source candidates, sample transactions and export. Use importer extension guidance before supplying custom processors.
Logical script references
Section titled “Logical script references”The compiler-selected script declarations are separate from this project’s host CLR surface. Read the script calling guide and the associated module contracts before using a projected member.
Source project facts
Section titled “Source project facts”Project: Inno.Assets.Pipeline
Source: src/content/assets/Inno.Assets.Pipeline/Inno.Assets.Pipeline.csproj
| Type | API | Description |
|---|---|---|
| AssetArtifactWriter | engine | Collects immutable named outputs for an aggregate asset build. |
| AssetBuildContext<TDefinition> | engine | Provides a stable input snapshot to an aggregate asset build. |
| AssetBuildProcessor | engine | Defines an automatically discovered aggregate asset build processor. |
| AssetBuildProcessorAttribute | engine | Declares the immutable cache protocol identity of an automatically discovered asset build processor. |
| AssetBuildProcessor<TDefinition> | engine | Provides a strongly typed aggregate asset build processor. |
| AssetCacheOptions | engine | Controls cleanup of rebuildable asset database data. |
| AssetCatalogCandidate | engine | Owns the isolated catalog storage used to validate one candidate Asset Pipeline generation. |
| AssetChangedEvent | engine | Batched file-system change event for asset source files. |
| AssetDeploymentScope | engine | Defines whether an imported asset participates in deployed runtime content. |
| AssetExportContext | engine | Provides generation-bound services for one editable asset source export. |
| AssetFileEntry | engine | One node in the asset source filesystem index. |
| AssetFileSystem | engine | Indexed asset source filesystem model backed by T:Inno.Assets.Pipeline.AssetWatcher. |
| AssetImportContext | engine | Collects source data and dependency declarations for one import operation. |
| AssetImportExtensionUnavailableException | engine | Reports a required authoring extension absent from the current generation. |
| AssetImportFailure | engine | Describes a writable-source import failure introduced after an earlier health snapshot. |
| AssetImportHealthSnapshot | engine | Represents an immutable observation of writable-source import failures at one point in time. |
| AssetImportSettingsSnapshot | engine | Provides a detached settings value and an optimistic concurrency token for its source sidecar. |
| AssetImportWriter<TAsset> | engine | Collects the complete candidate output of one source import. |
| AssetImporter | engine | Defines metadata shared by automatically discovered asset importers. |
| AssetImporterAttribute | engine | Declares the immutable protocol identity of an automatically discovered asset importer. |
| AssetImporter<TAsset> | engine | Provides the strongly typed implementation base for an asset importer. |
| AssetLoader | engine | Coordinates importing, persistent cataloging, canonical loading, reloading and collection for one source and artifact root pair. Resolves import settings and dependency invalidation for the asset loader. |
| AssetPipeline | engine | Provides the single application-level entry point for importing, loading, saving and collecting assets. Owns cancellable Sample preparation and owner-thread publication through the shared source transaction. Prepares isolated source catalogs and adopts them at the pipeline’s owner-thread safe point. |
| AssetPipelineMode | engine | Defines which side of the asset pipeline an T:Inno.Assets.Pipeline.AssetPipeline instance serves. |
| AssetPipelineOptions | engine | Initialization options for T:Inno.Assets.Pipeline.AssetPipeline. |
| AssetSample | engine | Defines authoring sample directories and their installed Plugin behavior. |
| AssetSampleImportTransaction | engine | Owns a cancellable sample clone, its pinned generation and its owner-thread publication. |
| AssetSampleSourceRewriterAttribute | engine | Registers a source-language sample transformer through the reloadable type catalog. |
| AssetSampleTransformContext | engine | Gives a source-language extension access to a staged sample clone before serialized references are remapped. |
| AssetSerializationServices | engine | Provides generation-bound structured serialization without exposing host registries to importer extensions. |
| AssetSourceMount | engine | Maps one isolated asset source to a controlled physical root. |
| AssetSourceMountTransaction | engine | Holds an isolated source-mount candidate that can be inspected before it atomically replaces the active Asset Database. |
| AssetSourcePolicy | engine | Defines which physical entries are excluded from an asset source tree. |
| AssetSourceSnapshot | engine | Contains detached authoring bytes and conflict-detection state. |
| AssetSourceStore | engine | Reads detached authoring bytes and saves them independently of successful import. |
| EditorAssets | engine | Provides Editor-script asset mutations through the authoring pipeline bound by the current host. |
| IAssetSampleSourceRewriter | engine | Rewrites a source language in a private sample clone before source assets are published. |
| IAssetSourceSnapshot | engine | Provides read-only authoring source access for active or isolated candidate compilation. |
| NativeAssetSourceSerialization | engine | Imports and exports editable asset source state through the common native serializer. |
| AssetArtifactWriter | Editor | Collects immutable named outputs for an aggregate asset build. |
| AssetBuildContext<TDefinition> | Editor | Provides a stable input snapshot to an aggregate asset build. |
| AssetBuildProcessor | Editor | Defines an automatically discovered aggregate asset build processor. |
| AssetBuildProcessorAttribute | Editor | Declares the immutable cache protocol identity of an automatically discovered asset build processor. |
| AssetBuildProcessor<TDefinition> | Editor | Provides a strongly typed aggregate asset build processor. |
| AssetDeploymentScope | Editor | Defines whether an imported asset participates in deployed runtime content. |
| AssetExportContext | Editor | Provides generation-bound services for one editable asset source export. |
| AssetFileEntry | Editor | One node in the asset source filesystem index. |
| AssetImportContext | Editor | Collects source data and dependency declarations for one import operation. |
| AssetImportExtensionUnavailableException | Editor | Reports a required authoring extension absent from the current generation. |
| AssetImportWriter<TAsset> | Editor | Collects the complete candidate output of one source import. |
| AssetImporter | Editor | Defines metadata shared by automatically discovered asset importers. |
| AssetImporterAttribute | Editor | Declares the immutable protocol identity of an automatically discovered asset importer. |
| AssetImporter<TAsset> | Editor | Provides the strongly typed implementation base for an asset importer. |
| AssetSerializationServices | Editor | Provides generation-bound structured serialization without exposing host registries to importer extensions. |
| EditorAssets | Editor | Provides Editor-script asset mutations through the authoring pipeline bound by the current host. |
| NativeAssetSourceSerialization | Editor | Imports and exports editable asset source state through the common native serializer. |