Enum cargo::util::command_prelude::CompileMode

pub enum CompileMode {
    Test,
    Build,
    Check {
        test: bool,
    },
    Bench,
    Doc {
        deps: bool,
    },
    Doctest,
    RunCustomBuild,
}

The general "mode" for what to do. This is used for two purposes. The commands themselves pass this in to compile_ws to tell it the general execution strategy. This influences the default targets selected. The other use is in the Unit struct to indicate what is being done with a specific target.

Variants

Test

A target being built for a test.

Build

Building a target with rustc (lib or bin).

Check

Building a target with rustc to emit rmeta metadata only. If test is true, then it is also compiled with --test to check it like a test.

Fields of Check

test: bool

Bench

Used to indicate benchmarks should be built. This is not used in Unit, because it is essentially the same as Test (indicating --test should be passed to rustc) and by using Test instead it allows some de-duping of Units to occur.

Doc

A target that will be documented with rustdoc. If deps is true, then it will also document all dependencies.

Fields of Doc

deps: bool

Doctest

A target that will be tested with rustdoc.

RunCustomBuild

A marker for Units that represent the execution of a build.rs script.

Implementations

impl CompileMode

pub fn is_check(self) -> bool

Returns true if the unit is being checked.

pub fn is_doc(self) -> bool

Returns true if this is generating documentation.

pub fn is_doc_test(self) -> bool

Returns true if this a doc test.

pub fn is_any_test(self) -> bool

Returns true if this is any type of test (test, benchmark, doc test, or check test).

pub fn is_rustc_test(self) -> bool

Returns true if this is something that passes --test to rustc.

pub fn is_run_custom_build(self) -> bool

Returns true if this is the execution of a build.rs script.

pub fn all_modes() -> &'static [CompileMode]

List of all modes (currently used by cargo clean -p for computing all possible outputs).

Trait Implementations

impl Clone for CompileMode

fn clone(&self) -> CompileMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CompileMode

impl Debug for CompileMode

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

Formats the value using the given formatter.

impl Eq for CompileMode

impl Hash for CompileMode

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 CompileMode

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<CompileMode> for CompileMode

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

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

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

This method tests for !=.

impl PartialOrd<CompileMode> for CompileMode

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

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

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

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

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

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

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

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

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

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

impl Serialize for CompileMode

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for CompileMode

impl StructuralPartialEq for CompileMode