Struct WasmBuildSpec 

pub struct WasmBuildSpec { /* private fields */ }

Complete caller-owned description of one cacheable Cargo Wasm build.

The package dependency closure, workspace manifest, lockfile, Cargo configuration, Rust toolchain files, target, profile arguments, explicit child environment, selected inherited environment, and additional watched inputs all contribute to the build fingerprint.

Implementations

impl WasmBuildSpec

pub fn new( workspace_root: &Path, target_dir: &Path, packages: &[&str], profile_target_dir: &str, ) -> Self

Describe one Cargo build targeting wasm32-unknown-unknown.

profile_target_dir is Cargo’s output subdirectory, such as debug, release, or the name supplied to --profile.

pub fn with_cargo_profile_args(self, arguments: &[&str]) -> Self

Set Cargo profile and feature arguments used for both the build and fingerprint.

pub fn with_cargo_profile_args_os<I, S>(self, arguments: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OsString>,

Set OS-native Cargo profile and feature arguments used for the build and fingerprint.

pub fn with_extra_env(self, environment: &[(&str, &str)]) -> Self

Set deterministic child-process environment overrides.

pub fn with_extra_env_os<I, K, V>(self, environment: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<OsString>, V: Into<OsString>,

Set OS-native deterministic child-process environment overrides.

pub fn with_inherited_env(self, names: &[&str]) -> Self

Add ambient environment variables whose current values affect the build.

Common Rust and Cargo toolchain variables are included automatically. Callers must declare application-specific variables read by build scripts.

pub fn with_inherited_env_os<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OsString>,

Add OS-native ambient environment names whose current values affect the build.

pub fn with_additional_inputs(self, paths: &[&str]) -> Self

Add files or directories not discoverable through Cargo’s local dependency graph.

Relative paths are resolved from the workspace root. Use this for build script configuration, generated schemas, or other externally read inputs.

pub fn with_additional_input_paths<I, P>(self, paths: I) -> Self

where I: IntoIterator<Item = P>, P: Into<PathBuf>,

Add path-native files or directories outside Cargo’s local dependency graph.

pub fn with_target(self, target: &str) -> Self

Override the Cargo compilation target.

pub fn with_cargo_program(self, program: impl Into<OsString>) -> Self

Override the Cargo executable used by metadata, identity, and build commands.

pub fn with_rustc_program(self, program: impl Into<OsString>) -> Self

Override the Rust compiler executable used to fingerprint the toolchain.

pub fn with_shared_incremental_target( self, target_dir: impl Into<PathBuf>, ) -> Self

Build cache misses in one caller-owned shared Cargo incremental target.

Exact final Wasm artifacts still live in the content-addressed cache. The shared target is coordinated across processes but is never pruned or removed by ic-testkit after a failed build.

pub const fn with_prune_policy(self, policy: WasmBuildCachePrunePolicy) -> Self

Apply cache retention under the build operation’s existing process lock.

Maintenance is best-effort: its structured result is attached to the successful build record and cannot turn ready artifacts into a build failure. The active fingerprint is protected from this pruning pass.

pub fn workspace_root(&self) -> &Path

Workspace containing the selected Cargo packages.

pub fn target_dir(&self) -> &Path

Cargo target directory containing artifacts, lock, and stamps.

pub fn packages(&self) -> &[String]

Selected Cargo package names.

pub const fn cache_mode(&self) -> &WasmBuildCacheMode

Cargo-target ownership mode used for cache misses.

Trait Implementations

impl Clone for WasmBuildSpec

fn clone(&self) -> WasmBuildSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WasmBuildSpec

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

Formats the value using the given formatter.

impl Eq for WasmBuildSpec

impl PartialEq for WasmBuildSpec

fn eq(&self, other: &WasmBuildSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WasmBuildSpec