# Enum cargo::core::compiler::CompileMode

source ·

    pub enum CompileMode {
        Test,
        Build,
        Check {
            test: bool,
        },
        Bench,
        Doc {
            deps: bool,
            json: 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`
§`json: bool`

A target that will be documented with `rustdoc`. If `deps` is true, then it will also document all dependencies. if `json` is true, the documentation output is in json format.

§

### 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§

source§

### impl CompileMode

source

#### pub fn is_check(self) -> bool

Returns `true` if the unit is being checked.

source

#### pub fn is_doc(self) -> bool

Returns `true` if this is generating documentation.

source

#### pub fn is_doc_test(self) -> bool

Returns `true` if this a doc test.

source

#### pub fn is_doc_scrape(self) -> bool

Returns `true` if this is scraping examples for documentation.

source

#### pub fn is_any_test(self) -> bool

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

source

#### pub fn is_rustc_test(self) -> bool

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

source

#### pub fn is_run_custom_build(self) -> bool

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

source

#### 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§

source§

### impl Clone for CompileMode

source§

#### fn clone(&self) -> CompileMode

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for CompileMode

source§

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

Formats the value using the given formatter. Read more
source§

### impl Hash for CompileMode

source§

#### fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given `Hasher`. Read more
1.3.0 · source§

#### fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given `Hasher`. Read more
source§

### impl Ord for CompileMode

source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · source§

#### fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

#### fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

#### fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

### impl PartialEq for CompileMode

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl PartialOrd for CompileMode

source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · source§

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

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · source§

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

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

### impl Serialize for CompileMode

source§

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

Serialize this value into the given Serde serializer. Read more
source§

### impl Copy for CompileMode

source§

### impl Eq for CompileMode

source§

### impl StructuralPartialEq for CompileMode

## Auto Trait Implementations§

§

### impl Freeze for CompileMode

§

### impl RefUnwindSafe for CompileMode

§

### impl Send for CompileMode

§

### impl Sync for CompileMode

§

### impl Unpin for CompileMode

§

### impl UnwindSafe for CompileMode

## Blanket Implementations§

source§

### impl<T> Any for T
where T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for T
where T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn compare(&self, key: &K) -> Ordering

Compare self to `key` and return their ordering.
§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

### impl<T, U> Into<U> for T
where U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

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

§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> Serialize for T
where T: Serialize + ?Sized,

source§

#### fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

source§

#### fn do_erased_serialize( &self, serializer: &mut dyn Serializer ) -> Result<(), ErrorImpl>

source§

### impl<T> ToOwned for T
where T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## 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`: 2 bytes
- `Doctest`: 0 bytes
- `Docscrape`: 0 bytes
- `RunCustomBuild`: 0 bytes