Struct cargo::core::profiles::UnitFor

pub struct UnitFor { /* private fields */ }

Flags used in creating Units to indicate the purpose for the target, and to ensure the target’s dependencies have the correct settings.

Implementations

impl UnitFor

pub fn new_normal() -> UnitFor

A unit for a normal target/dependency (i.e., not custom build, proc macro/plugin, or test/bench).

pub fn new_host(host_features: bool) -> UnitFor

A unit for a custom build script or proc-macro or its dependencies.

The host_features parameter is whether or not this is for a build dependency or proc-macro (something that requires being built “on the host”). Build scripts for non-host units should use false because they want to use the features of the package they are running for.

pub fn new_compiler() -> UnitFor

A unit for a compiler plugin or their dependencies.

pub fn new_test(config: &Config) -> UnitFor

A unit for a test/bench target or their dependencies.

Note that config is taken here for unstable CLI features to detect whether panic=abort is supported for tests. Historical versions of rustc did not support this, but newer versions do with an unstable compiler flag.

pub fn new_host_test(config: &Config) -> UnitFor

This is a special case for unit tests of a proc-macro.

Proc-macro unit tests are forced to be run on the host.

pub fn with_dependency(self, parent: &Unit, dep_target: &Target) -> UnitFor

Returns a new copy updated based on the target dependency.

This is where the magic happens that the host/host_features settings transition in a sticky fashion. As the dependency graph is being built, once those flags are set, they stay set for the duration of that portion of tree.

pub fn is_for_host(&self) -> bool

Returns true if this unit is for a build script or any of its dependencies, or a proc macro or any of its dependencies.

pub fn is_for_host_features(&self) -> bool

pub fn all_values() -> &'static [UnitFor]

All possible values, used by clean.

Trait Implementations

impl Clone for UnitFor

fn clone(&self) -> UnitFor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnitFor

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

Formats the value using the given formatter.

impl Hash for UnitFor

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for UnitFor

fn cmp(&self, other: &UnitFor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<UnitFor> for UnitFor

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<UnitFor> for UnitFor

fn partial_cmp(&self, other: &UnitFor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for UnitFor

impl Eq for UnitFor

impl StructuralEq for UnitFor

impl StructuralPartialEq for UnitFor