cargo::core::compiler

Enum UserIntent

Source 
pub enum UserIntent {
    Bench,
    Build,
    Check {
        test: bool,
    },
    Doc {
        deps: bool,
        json: bool,
    },
    Doctest,
    Test,
}
Expand description

Represents the high-level operation requested by the user.

It determines which “Cargo targets” are selected by default and influences how they will be processed. This is derived from the Cargo command the user invoked (like cargo build or cargo test).

Unlike CompileMode, which describes the specific compilation steps for individual units, UserIntent represents the overall goal of the build process as specified by the user.

For example, when a user runs cargo test, the intent is UserIntent::Test, but this might result in multiple CompileModes for different units.

Variants§

§

Bench

Build benchmark binaries, e.g., cargo bench

§

Build

Build binaries and libraries, e.g., cargo run, cargo install, cargo build.

§

Check

Perform type-check, e.g., cargo check.

Fields

§test: bool
§

Doc

Document packages.

If deps is true, then it will also document all dependencies. if json is true, the documentation output is in json format.

Fields

§deps: bool
§json: bool
§

Doctest

Build doctest binaries, e.g., cargo test --doc

§

Test

Build test binaries, e.g., cargo test

Implementations§

Source§

impl UserIntent

Source

pub fn is_doc(self) -> bool

Returns true if this is generating documentation.

Source

pub fn wants_doc_json_output(self) -> bool

User wants rustdoc output in JSON format.

Source

pub fn wants_deps_docs(self) -> bool

User wants to document also for dependencies.

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.

Trait Implementations§

Source§

impl Clone for UserIntent

Source§

fn clone(&self) -> UserIntent

Returns a duplicate 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 UserIntent

Source§

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

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

impl Copy for UserIntent

Auto Trait Implementations§

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

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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>,

Source§

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
§

impl<T> ErasedDestructor for T
where T: 'static,

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:

  • Bench: 0 bytes
  • Build: 0 bytes
  • Check: 2 bytes
  • Doc: 2 bytes
  • Doctest: 0 bytes
  • Test: 0 bytes