Enum CompileMode

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

The specific action to be performed on each Unit of work.

Variants

Test

Test with rustc.

Build

Compile with rustc.

Check

Type-check with rustc by emitting rmeta metadata only.

If test is true, then it is also compiled with --test to check it like a test.

Fields

test: bool

Doc

Document with rustdoc.

Doctest

Test with rustdoc.

Docscrape

Scrape for function calls by rustdoc.

RunCustomBuild

Execute the binary built from the 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_doc_scrape(self) -> bool

Returns true if this is scraping examples for documentation.

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 generates_executable(self) -> bool

Returns true if this mode may generate an executable.

Note that this also returns true for building libraries, so you also have to check the target.

Trait Implementations

impl Clone for CompileMode

fn clone(&self) -> CompileMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompileMode

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

Formats the value using the given formatter.

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

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.

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 CompileMode

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

impl Eq for CompileMode

impl StructuralPartialEq for CompileMode

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: 1 byte

Size for each variant:

• Test: 0 bytes
• Build: 0 bytes
• Check: 1 byte
• Doc: 0 bytes
• Doctest: 0 bytes
• Docscrape: 0 bytes
• RunCustomBuild: 0 bytes