BuildConfig in cargo::core::compiler - Rust
Description: Configuration information for a rustc build.

Skip to main content

## BuildConfig

# Struct BuildConfig

Source

    pub struct BuildConfig {Show 16 fields
        pub requested_kinds: Vec<CompileKind>,
        pub jobs: u32,
        pub keep_going: bool,
        pub requested_profile: InternedString,
        pub intent: UserIntent,
        pub message_format: MessageFormat,
        pub force_rebuild: bool,
        pub unit_graph: bool,
        pub dry_run: bool,
        pub primary_unit_rustc: Option<ProcessBuilder>,
        pub rustfix_diagnostic_server: Rc<RefCell<Option<RustfixDiagnosticServer>>>,
        pub export_dir: Option<PathBuf>,
        pub future_incompat_report: bool,
        pub timing_report: bool,
        pub sbom: bool,
        pub compile_time_deps_only: bool,
    }

Expand description

Configuration information for a rustc build.

## Fields§

§`requested_kinds: Vec<CompileKind>`

The requested kind of compilation for this session

§`jobs: u32`

Number of rustc jobs to run in parallel.

§`keep_going: bool`

Do not abort the build as soon as there is an error.

§`requested_profile: InternedString`

Build profile

§`intent: UserIntent`

The intent we are compiling in.

§`message_format: MessageFormat`

`true` to print stdout in JSON format (for machine reading).

§`force_rebuild: bool`

Force Cargo to do a full rebuild and treat each target as changed.

§`unit_graph: bool`

Output the unit graph to stdout instead of actually compiling.

§`dry_run: bool`

`true` to avoid really compiling.

§`primary_unit_rustc: Option<ProcessBuilder>`

An optional override of the rustc process for primary units

§`rustfix_diagnostic_server: Rc<RefCell<Option<RustfixDiagnosticServer>>>`

A thread used by `cargo fix` to receive messages on a socket regarding the success/failure of applying fixes.

§`export_dir: Option<PathBuf>`

The directory to copy final artifacts to. Note that even if `artifact-dir` is set, a copy of artifacts still can be found at `target/(debug\release)` as usual. Named `export_dir` to avoid confusion with `CompilationFiles::artifact_dir`.

§`future_incompat_report: bool`

`true` to output a future incompatibility report at the end of the build

§`timing_report: bool`

Output timing report at the end of the build

§`sbom: bool`

Output SBOM precursor files.

§`compile_time_deps_only: bool`

Build compile time dependencies only, e.g., build scripts and proc macros

## Implementations§

Source§

### impl BuildConfig

Source

#### pub fn new( gctx: &GlobalContext, jobs: Option<JobsConfig>, keep_going: bool, requested_targets: &[String], intent: UserIntent, ) -> CargoResult<BuildConfig>

Parses all config files to learn about build configuration. Currently configured options are:

- `build.jobs`
- `build.target`
- `target.$target.ar`
- `target.$target.linker`
- `target.$target.libfoo.metadata`

Source

#### pub fn emit_json(&self) -> bool

Whether or not the user wants JSON output. Whether or not rustc actually uses JSON is decided in `add_error_format`.

Source

#### pub fn single_requested_kind(&self) -> CargoResult<CompileKind>

## Trait Implementations§

Source§

### impl Clone for BuildConfig

Source§

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

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 BuildConfig

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl Freeze for BuildConfig

§

### impl !RefUnwindSafe for BuildConfig

§

### impl !Send for BuildConfig

§

### impl !Sync for BuildConfig

§

### impl Unpin for BuildConfig

§

### impl UnsafeUnpin for BuildConfig

§

### impl !UnwindSafe for BuildConfig

## 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<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: 280 bytes