Struct UnitInner

pub struct UnitInner {

    pub pkg: Package,
    pub target: Target,
    pub profile: Profile,
    pub kind: CompileKind,
    pub mode: CompileMode,
    pub features: Vec<InternedString>,
    pub rustflags: Rc<[String]>,
    pub rustdocflags: Rc<[String]>,
    pub links_overrides: Rc<BTreeMap<String, BuildOutput>>,
    pub artifact: IsArtifact,
    pub is_std: bool,
    pub dep_hash: u64,
    pub artifact_target_for_features: Option<CompileTarget>,
}

Internal fields of Unit which Unit will dereference to.

Fields

pkg: Package

Information about available targets, which files to include/exclude, etc. Basically stuff in Cargo.toml.

target: Target

Information about the specific target to build, out of the possible targets in pkg. Not to be confused with target-triple (or target architecture …), the target arch for a build.

profile: Profile

The profile contains information about how the build should be run, including debug level, etc.

kind: CompileKind

Whether this compilation unit is for the host or target architecture.

For example, when cross compiling and using a custom build script, the build script needs to be compiled for the host architecture so the host rustc can use it (when compiling to the target architecture).

mode: CompileMode

The “mode” this unit is being compiled for. See CompileMode for more details.

features: Vec<InternedString>

The cfg features to enable for this unit. This must be sorted.

rustflags: Rc<[String]>

Extra compiler flags to pass to rustc for a given unit.

Although it depends on the caller, in the current Cargo implementation, these flags take precedence over those from BuildContext::extra_args_for.

As of now, these flags come from environment variables and configurations. See TargetInfo.rustflags for more on how Cargo collects them.

rustdocflags: Rc<[String]>

Extra compiler flags to pass to rustdoc for a given unit.

Although it depends on the caller, in the current Cargo implementation, these flags take precedence over those from BuildContext::extra_args_for.

As of now, these flags come from environment variables and configurations. See TargetInfo.rustdocflags for more on how Cargo collects them.

links_overrides: Rc<BTreeMap<String, BuildOutput>>

Build script override for the given library name.

Any package with a links value for the given library name will skip running its build script and instead use the given output from the config file.

artifact: IsArtifact

is_std: bool

Whether this is a standard library unit.

dep_hash: u64

A hash of all dependencies of this unit.

This is used to keep the Unit unique in the situation where two otherwise identical units need to link to different dependencies. This can happen, for example, when there are shared dependencies that need to be built with different features between normal and build dependencies. See rebuild_unit_graph_shared for more on why this is done.

This value initially starts as 0, and then is filled in via a second-pass after all the unit dependencies have been computed.

artifact_target_for_features: Option<CompileTarget>

This is used for target-dependent feature resolution and is copied from FeaturesFor::ArtifactDep, if the enum matches the variant.

Implementations

impl UnitInner

pub fn requires_upstream_objects(&self) -> bool

Returns whether compilation of this unit requires all upstream artifacts to be available.

This effectively means that this unit is a synchronization point (if the return value is true) that all previously pipelined units need to finish in their entirety before this one is started.

pub fn is_local(&self) -> bool

Returns whether or not this is a “local” package.

A “local” package is one that the user can likely edit, or otherwise wants warnings, etc.

pub fn show_warnings(&self, gctx: &GlobalContext) -> bool

Returns whether or not warnings should be displayed for this unit.

Trait Implementations

impl Clone for UnitInner

fn clone(&self) -> UnitInner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for UnitInner

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 UnitInner

fn cmp(&self, other: &UnitInner) -> 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 UnitInner

fn eq(&self, other: &UnitInner) -> 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 UnitInner

fn partial_cmp(&self, other: &UnitInner) -> 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 Eq for UnitInner

impl StructuralPartialEq for UnitInner

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 304 bytes