Struct rustc_ap_rustc_session::config::Options

pub struct Options {

    pub crate_types: Vec<CrateType>,
    pub optimize: OptLevel,
    pub debug_assertions: bool,
    pub debuginfo: DebugInfo,
    pub lint_opts: Vec<(String, Level)>,
    pub lint_cap: Option<Level>,
    pub describe_lints: bool,
    pub output_types: OutputTypes,
    pub search_paths: Vec<SearchPath>,
    pub libs: Vec<NativeLib>,
    pub maybe_sysroot: Option<PathBuf>,
    pub target_triple: TargetTriple,
    pub test: bool,
    pub error_format: ErrorOutputType,
    pub incremental: Option<PathBuf>,
    pub debugging_opts: DebuggingOptions,
    pub prints: Vec<PrintRequest>,
    pub borrowck_mode: BorrowckMode,
    pub cg: CodegenOptions,
    pub externs: Externs,
    pub extern_dep_specs: ExternDepSpecs,
    pub crate_name: Option<String>,
    pub alt_std_name: Option<String>,
    pub unstable_features: UnstableFeatures,
    pub actually_rustdoc: bool,
    pub trimmed_def_paths: TrimmedDefPaths,
    pub cli_forced_codegen_units: Option<usize>,
    pub cli_forced_thinlto_off: bool,
    pub remap_path_prefix: Vec<(PathBuf, PathBuf)>,
    pub real_rust_source_base_dir: Option<PathBuf>,
    pub edition: Edition,
    pub json_artifact_notifications: bool,
    pub json_unused_externs: bool,
    pub pretty: Option<PpMode>,
}

The top-level command-line options struct.

For each option, one has to specify how it behaves with regard to the dependency tracking system of incremental compilation. This is done via the square-bracketed directive after the field type. The options are:

• [TRACKED] A change in the given field will cause the compiler to completely clear the incremental compilation cache before proceeding.

• [TRACKED_NO_CRATE_HASH] Same as [TRACKED], but will not affect the crate hash. This is useful for options that only affect the incremental cache.

• [UNTRACKED] Incremental compilation is not influenced by this option.

• [SUBSTRUCT] Second-level sub-structs containing more options.

If you add a new option to this struct or one of the sub-structs like CodegenOptions, think about how it influences incremental compilation. If in doubt, specify [TRACKED], which is always “correct” but might lead to unnecessary re-compilation.

Fields

crate_types: Vec<CrateType>

The crate config requested for the session, which may be combined with additional crate configurations during the compile process.

optimize: OptLevel

debug_assertions: bool

Include the debug_assertions flag in dependency tracking, since it can influence whether overflow checks are done or not.

debuginfo: DebugInfo

lint_opts: Vec<(String, Level)>

lint_cap: Option<Level>

describe_lints: bool

output_types: OutputTypes

search_paths: Vec<SearchPath>

libs: Vec<NativeLib>

maybe_sysroot: Option<PathBuf>

target_triple: TargetTriple

test: bool

error_format: ErrorOutputType

incremental: Option<PathBuf>

If Some, enable incremental compilation, using the given directory to store intermediate results.

debugging_opts: DebuggingOptions

prints: Vec<PrintRequest>

borrowck_mode: BorrowckMode

Determines which borrow checker(s) to run. This is the parsed, sanitized version of debugging_opts.borrowck, which is just a plain string.

cg: CodegenOptions

externs: Externs

extern_dep_specs: ExternDepSpecs

crate_name: Option<String>

alt_std_name: Option<String>

An optional name to use as the crate for std during std injection, written extern crate name as std. Defaults to std. Used by out-of-tree drivers.

unstable_features: UnstableFeatures

Indicates how the compiler should treat unstable features.

actually_rustdoc: bool

Indicates whether this run of the compiler is actually rustdoc. This is currently just a hack and will be removed eventually, so please try to not rely on this too much.

trimmed_def_paths: TrimmedDefPaths

Control path trimming.

cli_forced_codegen_units: Option<usize>

Specifications of codegen units / ThinLTO which are forced as a result of parsing command line options. These are not necessarily what rustc was invoked with, but massaged a bit to agree with commands like --emit llvm-ir which they’re often incompatible with if we otherwise use the defaults of rustc.

cli_forced_thinlto_off: bool

remap_path_prefix: Vec<(PathBuf, PathBuf)>

Remap source path prefixes in all output (messages, object files, debug, etc.).

real_rust_source_base_dir: Option<PathBuf>

Base directory containing the src/ for the Rust standard library, and potentially rustc as well, if we can can find it. Right now it’s always $sysroot/lib/rustlib/src/rust (i.e. the rustup rust-src component).

This directory is what the virtual /rustc/$hash is translated back to, if Rust was built with path remapping to /rustc/$hash enabled (the rust.remap-debuginfo option in config.toml).

edition: Edition

json_artifact_notifications: bool

true if we’re emitting JSON blobs about each artifact produced by the compiler.

json_unused_externs: bool

true if we’re emitting a JSON blob containing the unused externs

pretty: Option<PpMode>

Implementations

impl Options

pub fn build_dep_graph(&self) -> bool

Returns true if there is a reason to build the dep graph.

pub fn file_path_mapping(&self) -> FilePathMapping

pub fn will_create_output_file(&self) -> bool

Returns true if there will be an output file generated.

pub fn share_generics(&self) -> bool

impl Options

pub fn dep_tracking_hash(&self, for_crate_hash: bool) -> u64

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.