Struct BuildOptions 

pub struct BuildOptions { /* private fields */ }

Options that control how a crate is built.

These options map to flags passed to cargo build. They are orthogonal to the crate identity and location (see crate::CrateSpec), focusing instead on build configuration, feature selection, and compilation settings.

There is a somewhat blurry line between Config and BuildOptions; the intention is that Config contains all parameters that can either be set via config file or overridden via CLI argument, and encompasses parameters regulating all aspects of cgx behavior. By contrast, BuildOptions is specifically capturing options that effect how a crate is built; to a first approximation you can think of this as a Rust struct that represents the args passed to cargo build when building the user’s desired crate from source.

There are some CLI args that are inherently crate-specifie (such as --features), which are not present in Config and cannot be set in the config files; those naturally are captured as part of BuildOptions. However there are others like --locked and --target that can be overridden for all crates via config file or applied to a specific invocation via CLI arg; those are present here because they directly influence the command line passed to cargo build, although they get populated from the Config struct which reflects settings in the config files and any overrides of those settings that the user applied at the CLI.

Another way to reason about whether something should be in this struct or in Config is that this struct implements Hash, and that hash is used a cache key for caching build artifacts. So if a field has a different value, should that invalidate any cached build artifacts and cause a rebuild? If so, then it probably belongs here. If not, then it probably belongs in Config. A good example of this is the verbose command, which literally translates into a cargo command but is NOT considered a build option, because why would we rebuild a crate just because the verbosity level is different?

Implementations

impl BuildOptions

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

Features to activate.

pub fn all_features(&self) -> bool

Whether all available features are activated.

pub fn no_default_features(&self) -> bool

Whether the default feature is disabled.

pub fn profile(&self) -> Option<&str>

The build profile to use.

pub fn target(&self) -> Option<&str>

The explicit target triple for cross-compilation, if one was requested.

pub fn locked(&self) -> bool

Whether Cargo.lock must remain unchanged.

pub fn offline(&self) -> bool

Whether Cargo should run without accessing the network.

pub fn jobs(&self) -> Option<usize>

The requested number of parallel jobs for compilation.

pub fn ignore_rust_version(&self) -> bool

Whether to ignore package rust-version declarations.

pub fn build_target(&self) -> &BuildTarget

Which executable within the crate to build.

pub fn toolchain(&self) -> Option<&str>

The Rust toolchain override to use for this build.

pub fn load(config: &Config, overrides: &BuildOverrides) -> Result<Self>

Merge build options from config and already-translated CLI overrides, with proper precedence.

Config-handled settings (locked, offline, toolchain) come from Config, which has already processed CLI overrides like --locked, --unlocked, --frozen, --offline.

Crate-specific settings (features, profile, target, etc.) come from BuildOverrides, which the CLI front-end has already produced from the raw arguments (tokenizing features, folding --debug, resolving --bin/--example).

pub fn load_for_crate( config: &Config, overrides: &BuildOverrides, crate_spec: &CrateSpec, ) -> Result<Self>

Load the build options for a specific crate.

This will respect the [tools] section in the cgx config TOML, if there is an entry for this crate then the options specified for that crate will be applied unless they have been overridden in BuildOverrides.

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.

impl Default for BuildOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuildOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BuildOptions

impl Hash for BuildOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BuildOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BuildOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuildOptions