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

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

Fields

§test: bool

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.

§

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

Fields

§deps: bool

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

§

Doctest

A target that will be tested with rustdoc.

§

Docscrape

An example or library that will be scraped for function calls by rustdoc.

§

RunCustomBuild

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

Implementations§

Returns true if the unit is being checked.

Returns true if this is generating documentation.

Returns true if this a doc test.

Returns true if this is scraping examples for documentation.

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

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

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

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§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Compare self to key and return true if they are equal.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.

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: 2 bytes

Size for each variant:

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