Struct BuildOptions 

pub struct BuildOptions { /* private fields */ }

Options for building Rust libraries.

Implementations

impl BuildOptions

pub fn development(profile: BuildProfile) -> Self

Create options for a development build that uses the shared Rust runtime.

Development runs want wall-clock speed: Release and Profiling force opt-level 3 rather than the size-optimized opt-level "z" the packaging profile declares, and Optimized/Profiling/Release all carry CARGO_PROFILE_* overrides the cargo invocation applies.

pub fn with_static_runtime(self) -> Self

Link the Rust runtime in, whatever the caller asked for.

A platform whose loader cannot accept the toolchain’s prebuilt runtime says so here rather than at the link step, so that the target directory and the staged libraries agree with what is actually built.

pub const fn packaging(profile: BuildProfile) -> Self

Create options for a self-contained package build.

A packaged artifact builds under the profile the workspace declares — no CARGO_PROFILE_* overrides: the release profile’s size tuning (opt-level "z", symbol stripping) is the shipped configuration.

pub const fn is_release(&self) -> bool

Whether the build uses Cargo’s release profile.

pub const fn profile(&self) -> BuildProfile

The selected build profile.

pub fn cargo_envs(&self) -> &[(String, OsString)]

CARGO_PROFILE_* overrides the cargo invocation applies.

pub const fn with_dev_server(self, dev_server: bool) -> Self

Mark web mounts as dev-server-served for asset staging this build does.

pub const fn uses_dev_server(&self) -> bool

Whether web mounts are dev-server-served and skipped during staging.

pub fn output_dir(&self) -> Option<&Path>

Get the output directory, if specified

pub fn with_output_dir(self, output_dir: impl Into<PathBuf>) -> Self

Set the output directory where built libraries should be copied

pub fn sccache_path(&self) -> Option<&Path>

Get the sccache path, if configured

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

Set the sccache path for compilation caching.

When set, RUSTC_WRAPPER will be configured to use sccache, which can significantly improve build times by caching compiled artifacts.

pub const fn target_triple(&self) -> Option<&Triple>

Get the explicit target triple override, if configured.

pub fn with_target_triple(self, target_triple: Triple) -> Self

Override the target triple used for compilation.

pub const fn linkage(&self) -> RustLinkage

Get the selected Rust runtime linkage.

pub const fn with_dynamic_module_loading(self) -> Self

Mark the built app as a host for dlopen’d WaterUI modules.

A preview support app resolves a pushed module’s framework symbols against the runtime it already has open, so the shared runtime has to ship in the package rather than be linked into the app alone.

pub const fn loads_dynamic_modules(&self) -> bool

Whether the built app hosts dynamically loaded WaterUI modules.

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

Attach a compile-progress sink every cargo invocation this build performs reports to.

pub const fn progress(&self) -> Option<&BuildProgress>

The compile-progress sink, when one is attached.

Trait Implementations

impl Clone for BuildOptions

fn clone(&self) -> BuildOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildOptions

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

Formats the value using the given formatter.