Struct RustBuild 

pub struct RustBuild { /* private fields */ }

Represents a Rust build for a specific target triple.

Implementations

impl RustBuild

pub fn new(path: impl AsRef<Path>, triple: Triple) -> Self

Create a new rust build for the given path and target triple.

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

Use an explicit Cargo target directory.

pub fn with_sccache(self, sccache_path: PathBuf) -> Self

Set the sccache path for compilation caching.

When set, RUSTC_WRAPPER will be configured to use sccache, which can significantly improve incremental build times.

pub fn with_feature(self, feature: impl Into<String>) -> Self

Add a Cargo feature to enable during the build.

Features are passed to cargo via --features.

pub fn with_features( self, features: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Add multiple Cargo features to enable during the build.

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

Cargo features this build passes via --features.

pub fn with_rustc_flag(self, flag: impl Into<String>) -> Self

Add a rustc flag to the build via RUSTFLAGS.

pub fn with_final_rustc_arg(self, flag: impl Into<String>) -> Self

Add a rustc flag that applies to the final crate only.

The flag is passed as a trailing cargo rustc argument instead of through RUSTFLAGS, so dependency unit fingerprints stay identical across builds that differ only in how their final artifact links. See the field documentation on final_rustc_args for why link arguments must take this route.

pub fn with_build_std(self, toolchain: impl Into<String>) -> Self

Build the Rust standard library from source with -Zbuild-std on the named toolchain (a nightly with rust-src), sharing one libstd dylib across the graph.

The build runs Cargo under the water rustc wrapper (crate::rustc_wrapper): Cargo strips dylib from std’s crate types under -Zbuild-std, and the wrapper restores it so the produced libstd-*.so carries the same strict version hash as the rlib every dependent is compiled against. The wrapper also publishes the dylib into the profile’s deps/ directory, where RustDynamicLibraries::resolve finds it before the toolchain’s prebuilt copy.

pub fn with_preferred_dynamic_linking(self) -> Self

Prefer dynamic Rust dependencies and emit loader search paths for them.

pub fn with_linkage( self, linkage: RustLinkage, development_feature: &str, loader_search_path: Option<&str>, ) -> Self

Configure this build for the selected Rust runtime linkage.

A shared-runtime development build enables the project’s dev feature (which resolves the shared waterui-dylib runtime), prefers dynamic linking, and — when the platform’s loader needs one — embeds a loader search path into the final artifact only. A static packaging build needs none of this.

pub fn with_crate_type_override(self, crate_type: impl Into<String>) -> Self

Override the library crate type passed to rustc.

pub fn with_env( self, key: impl Into<String>, value: impl Into<OsString>, ) -> Self

Add an environment variable for the cargo build process.

pub fn with_envs( self, envs: impl IntoIterator<Item = (String, OsString)>, ) -> Self

Add multiple environment variables for the cargo build process.

pub fn with_progress(self, progress: BuildProgress) -> Self

Attach a compile-progress sink the cargo invocation reports to.

Each CompileEvent is parsed from cargo’s own stderr stream, so the report is driven by build output rather than a timer.

pub const fn triple(&self) -> &Triple

Get the target triple for this build.

pub async fn dev_build(&self) -> Result<BuiltTarget, RustBuildError>

Build rust library in development mode.

Will produce debug symbols and less optimizations for faster builds.

Errors

• RustBuildError::FailToExecuteCargoBuild: If there was an error executing the cargo build command.
• RustBuildError::FailToBuildRustLibrary: If there was an error building the Rust library.

pub async fn release_build(&self) -> Result<BuiltTarget, RustBuildError>

Build rust library in release mode.

Errors

• RustBuildError::FailToExecuteCargoBuild: If there was an error executing the cargo build command.
• RustBuildError::FailToBuildRustLibrary: If there was an error building the Rust library.

pub async fn build_lib( &self, release: bool, ) -> Result<BuiltTarget, RustBuildError>

Build the crate’s library target.

The returned BuiltTarget carries the profile directory plus the artifact Cargo reported. A crate emitting several library crate types needs Self::with_crate_type_override to say which one is wanted — the build fails rather than guess.

Errors

• RustBuildError::FailToExecuteCargoBuild: If there was an error executing the cargo build command.
• RustBuildError::FailToBuildRustLibrary: If there was an error building the Rust library.

pub async fn build_dylib( &self, release: bool, ) -> Result<PathBuf, RustBuildError>

Build a dynamic library (cdylib) and return the full path to the dylib file.

The path is Cargo’s own compiler-artifact report, so the returned file is the one this build wrote even when another project’s identically named crate shares the target directory.

Errors

• RustBuildError::FailToExecuteCargoBuild: If there was an error executing the cargo build command.
• RustBuildError::FailToBuildRustLibrary: If the library was not found after building.

pub async fn build_binary( &self, binary_name: &str, release: bool, ) -> Result<PathBuf, RustBuildError>

Builds one named binary and returns its full output path.

The path is Cargo’s own compiler-artifact report (executable of the --bin unit), so it is the binary this build wrote even when another project’s identically named crate shares the target directory.

Errors

Returns an error when Cargo fails or the expected binary is missing.

pub async fn dylib_path( &self, crate_name: &str, release: bool, ) -> Result<PathBuf, RustBuildError>

Compute the expected dylib output path without building.

This uses cargo metadata to resolve the target directory to avoid assuming a fixed target/ path.

Errors

Returns an error if Cargo metadata cannot be read.

pub async fn lib_output_dir( &self, release: bool, ) -> Result<PathBuf, RustBuildError>

Resolve the Cargo library artifact directory for this build target and profile.

Errors

Returns an error if Cargo metadata cannot be read for this build target.

Trait Implementations

impl Clone for RustBuild

fn clone(&self) -> RustBuild

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RustBuild

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

Formats the value using the given formatter.