Struct 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 with_for_host(self, for_host: bool) -> UnitFor

Returns a new copy based on for_host setting.

When for_host is true, this clears panic_abort_ok in a sticky fashion so that all its dependencies also have panic_abort_ok=false. This’ll help ensure that once we start compiling for the host platform (build scripts, plugins, proc macros, etc) we’ll share the same build graph where everything is panic=unwind.

pub fn with_host_features(self, host_features: bool) -> UnitFor

Returns a new copy updating it whether or not it should use features for build dependencies and proc-macros.

This is part of the machinery responsible for handling feature decoupling for build dependencies in the new feature resolver.

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 duplicate 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, Self: Sized,

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UnitFor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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 StructuralPartialEq for UnitFor