Struct BuildConfig 

pub struct BuildConfig {

    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 build_plan: 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_outputs: Vec<TimingOutput>,
    pub sbom: bool,
    pub compile_time_deps_only: bool,
}

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.

build_plan: bool

Output a build plan to stdout instead of actually compiling.

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_outputs: Vec<TimingOutput>

Which kinds of build timings to output (empty if none).

sbom: bool

Output SBOM precursor files.

compile_time_deps_only: bool

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

Implementations

impl BuildConfig

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

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.

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

Trait Implementations

impl Clone for BuildConfig

fn clone(&self) -> BuildConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildConfig

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

Formats the value using the given formatter.

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