Struct Environment

pub struct Environment { /* private fields */ }

A description of the current build environment

Implementations

impl Environment

pub fn new() -> Result<Environment, EnvironmentError>

Construct a new build configuration structure, or die trying.

pub fn cargo(&self) -> &Path

Get the path to the cargo executables

pub fn locked(&self) -> bool

Get whether cargo was invoked with the --locked flag

pub fn features(&self) -> HashSetIter<'_, String>

Get a reference to a hash set of enabled cargo features (as lower-kebab-case strings)

pub fn feature(&self, feature: &str) -> bool

Get whether a feature is enabled or not.

Feature names are normalized into lower-kebab-case (as opposed to UPPER_SNAKE_CASE).

pub fn depvars(&self) -> HashMapIter<'_, String, String>

Get a reference to a hash map of variables injected by the current crate’s dependencies

pub fn depvar(&self, var: &str) -> Option<&str>

Get the contents of a particular depvar, if one is provided.

pub fn dir(&self) -> &Path

Get the directory where the current Cargo.toml resides

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

Get the string contents of this crate’s links key

pub fn debug(&self) -> bool

Get whether debug is enabled on this build

pub fn host(&self) -> &str

Get the hostname of the build

pub fn linker(&self) -> &Path

Get the path to the linker executable being used

pub fn num_jobs(&self) -> usize

Get the number of jobs which can be run in parallel

pub fn out_dir(&self) -> &Path

Get the output directory path

pub fn opt_level(&self) -> usize

Get the optimization level

pub fn profile(&self) -> &str

Get the build profile as a string

pub fn rustc(&self) -> &Path

Get the path to the rustc compiler being used

pub fn rustdoc(&self) -> &Path

Get the path to the rustdoc executable being used

pub fn target(&self) -> &str

Get the target triple string

pub fn version(&self) -> &str

Get the package version string

pub fn version_major(&self) -> u64

Get the package version major number

pub fn version_minor(&self) -> u64

Get the package version minor number

pub fn version_patch(&self) -> u64

Get the package version patch number

pub fn version_pre(&self) -> Option<String>

Get the package version pre-release number

pub fn authors(&self) -> &HashSet<String>

Get a reference to a hash set of package author strings

pub fn name(&self) -> &str

Get the name of the package of the current package

pub fn description(&self) -> &str

Get the description of the current package

pub fn homepage(&self) -> &str

Get the homepage of the current package

pub fn repository(&self) -> &str

Get the repository of the current package

pub fn debug_assertions(&self) -> bool

Get whether or not debug assertions are enabled in this build

pub fn proc_macro(&self) -> bool

Get whether or not proc macros are enabled in this build

pub fn target_arch(&self) -> &str

Get the target architecture

pub fn target_endian(&self) -> Endianness

Get the endianness

pub fn target_env(&self) -> &str

Get the target environment

pub fn target_family(&self) -> TargetFamily

Get the target architecture family

pub fn target_features(&self) -> &HashSet<String>

Get a reference to the target feature set

pub fn target_has_atomic(&self) -> &HashSet<String>

Get a list of types which support atomic operations on the target platform

pub fn target_has_atomic_load_store(&self) -> &HashSet<String>

Get a list of types which support atomic load and store

pub fn target_os(&self) -> &str

Get the target OS

pub fn target_pointer_width(&self) -> usize

Get the target pointer width

pub fn target_thread_local(&self) -> bool

Get whether thread-local storage is available

pub fn target_vendor(&self) -> &str

Get the target triple vendor

pub fn target_dir(&self) -> &Path

Get the target directory (i.e. the --target-dir flag)

pub fn profile_target_dir(&self) -> &Path

Get the profile target directory

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Default for Environment

fn default() -> Environment

Returns the “default value” for a type.