Skip to main content

Module artifacts

Module artifacts 

Source
Expand description

Host-side artifact discovery, freshness, and Wasm build helpers.

These functions keep integration-test artifacts in caller-selected target directories and contain no application-specific package or profile policy. Independent Wasm batches remain sequential; WasmBuildSession adds only explicit cross-call resolution reuse under a caller-held source lease.

Structs§

ArtifactBuildTransaction
Owned miss transaction holding the recipe and content-key process locks.
ArtifactCacheArtifact
One logical artifact materialized at its caller-selected destination.
ArtifactCacheBatchEntry
One ordered labeled result from a generic artifact batch.
ArtifactCacheBatchFailedEntry
One failed generic artifact batch entry.
ArtifactCacheBatchFailureTimings
Partial phase timings retained for one failed artifact batch entry.
ArtifactCacheBatchMetrics
Aggregate counters and successful-acquisition timings for an artifact batch.
ArtifactCacheBatchOutcomeEntry
One successful generic artifact batch entry.
ArtifactCacheBatchReport
Ordered labeled entries from a collect-all artifact transaction batch.
ArtifactCachePrunePolicy
Caller-selected retention limits for content-addressed artifact entries.
ArtifactCachePruneReport
Summary of one lock-coordinated artifact-cache pruning pass.
ArtifactCacheRecord
Details shared by built and reused transactional artifact outcomes.
ArtifactCacheSpec
Complete caller-owned description of one transactional artifact set.
ArtifactCacheTimings
Phase timings for one transactional artifact-cache acquisition.
CargoBuildInput
One exact local Cargo source or configuration input under a stable logical label.
InputDigest
SHA-256 digest of one deterministic artifact-input set.
LabeledArtifactCacheSpec
Caller-labeled specification for one generic artifact batch entry.
LabeledWasmBuildSpec
Caller-labeled specification for one exact Wasm batch entry.
ResolvedCargoBuildInputs
Resolved exact inputs and identity for one WasmBuildSpec.
SharedIncrementalTargetInspection
Lock-coordinated disk-usage observation for a caller-owned shared Cargo target.
SharedIncrementalTargetMaintenance
Result of explicit shared Cargo target maintenance.
SharedIncrementalTargetMaintenanceConfig
Scheduled shared incremental-target maintenance attached to a Wasm acquisition.
SharedIncrementalTargetPrunePolicy
Whole-target retention limits for caller-owned shared Cargo state.
WasmBuildBatchConfig
Orchestration shared by every entry in one independent Wasm build batch.
WasmBuildBatchEntry
One ordered caller-labeled result from a Wasm build batch.
WasmBuildBatchFailure
One failed Wasm batch entry with its retained wall-clock time.
WasmBuildBatchMaintenanceEntry
One integrated shared-target maintenance outcome from a Wasm batch.
WasmBuildBatchMetrics
Aggregate counters and successful-acquisition timings for a Wasm build batch.
WasmBuildBatchOutcomeEntry
One successful Wasm batch entry.
WasmBuildBatchReport
Ordered outcomes and failures from a collect-all Wasm build batch.
WasmBuildFailureDetails
Structured phase and partial timings for one failed Wasm entry.
WasmBuildFailureTimings
Partial phase timings retained when a Wasm acquisition fails.
WasmBuildProgressConfig
Observation settings for one cacheable Wasm build.
WasmBuildRecord
Details shared by built and reused Wasm outcomes.
WasmBuildSession
Explicit cross-call input snapshot scoped to a caller-held source lease.
WasmBuildSessionMetrics
Aggregate state retained by one explicit Wasm build session.
WasmBuildSpec
Complete caller-owned description of one cacheable Cargo Wasm build.
WasmBuildTimings
Timings for cache coordination, input resolution, and Cargo execution.
WasmInputResolutionTimings
Detailed timings for exact Wasm build-input resolution.
WatchedInputSnapshot
Exact content digest captured across a set of watched input trees.

Enums§

ArtifactCacheBatchContractError
Structural error that prevents a labeled artifact batch from starting.
ArtifactCacheBatchFailure
Failure from one entry in a collect-all artifact transaction batch.
ArtifactCacheBatchFailurePhase
Primary phase in which a generic artifact batch entry failed.
ArtifactCacheError
Structured failure from transactional artifact caching.
ArtifactCacheMaintenance
Nonfatal retention attempted as part of a successful cache acquisition.
ArtifactCacheOutcome
Whether an artifact transaction published or reused its exact output set.
ArtifactCachePreparation
Result of preparing a transactional artifact-set acquisition.
ArtifactOutputValidation
Built-in validation applied to one transactional artifact output.
SharedIncrementalTargetMaintenanceFailureMode
Failure handling for integrated shared incremental-target maintenance.
SharedIncrementalTargetMaintenanceOutcome
Result of interval-limited shared Cargo target maintenance.
WasmBuildBatchContractError
Structural error that prevents a labeled Wasm batch from starting.
WasmBuildBatchProgressEvent
Structured progress for an independent sequence of exact Wasm builds.
WasmBuildCacheMode
Cargo-target ownership mode for one exact cached Wasm build.
WasmBuildError
Structured failure from a cacheable Wasm build.
WasmBuildFailurePhase
Primary phase in which one cacheable Wasm acquisition failed.
WasmBuildOutcome
Whether a cacheable Wasm build ran Cargo or reused exact matching artifacts.
WasmBuildOutputStream
Raw child-process stream attached to a Cargo progress event.
WasmBuildPhase
External phase associated with a cacheable Wasm build failure.
WasmBuildProgressEvent
Structured progress emitted by an observed cacheable Wasm build.
WasmBuildProgressOutcome
Final cache state reported by a successful observed build.
WasmBuildProgressPhase
Potentially long phase of one observed Wasm-cache acquisition.

Functions§

build_artifact_caches_batch
Build every independent caller-labeled artifact specification.
build_wasm_canisters_cached
Build or reuse one exact set of Cargo Wasm artifacts.
build_wasm_canisters_cached_batch
Build every Wasm specification as an independent Cargo invocation.
build_wasm_canisters_cached_batch_with_config
Build an independent Wasm batch with shared batch orchestration.
build_wasm_canisters_cached_batch_with_config_and_progress
Build a configured independent Wasm batch while forwarding structured progress.
build_wasm_canisters_cached_batch_with_progress
Build an independent Wasm batch while forwarding structured progress.
build_wasm_canisters_cached_with_progress
Build or reuse one exact Wasm set while streaming structured progress.
icp_artifact_ready_for_build
Check whether an ICP artifact exists, is nonempty, and is fresh against watched inputs.
icp_artifact_ready_with_snapshot
Check one ICP artifact against one already-captured watched-input snapshot.
inspect_shared_incremental_target
Inspect one configured shared Cargo target under its build coordination lock.
maintain_shared_incremental_target
Apply explicit whole-target retention to caller-owned shared Cargo state.
maintain_shared_incremental_target_at_most_every
Apply whole-target retention at most once per interval across processes.
prepare_artifact_cache
Verify or begin one exact external artifact-set transaction.
prune_artifact_cache
Prune one transactional artifact namespace without acquiring an artifact.
prune_wasm_build_cache
Prune fingerprint-specific Cargo target directories under target_dir.
read_wasm
Read a compiled Wasm artifact for one crate.
resolve_cargo_build_inputs
Resolve the exact Cargo source, configuration, toolchain, argument, and environment identity.
resolve_executable
Resolve one executable exactly as an artifact-cache tool input.
test_target_dir
Return <workspace>/target/<name> for isolated host-side test artifacts.
wasm_artifacts_ready
Check whether every requested Wasm artifact is a regular file.
wasm_path
Resolve one crate’s Wasm artifact under a caller-selected Cargo target directory.
workspace_root_for
Resolve the conventional workspace root from a crate manifest directory.