Struct cargo::ops::CompileOptions

pub struct CompileOptions {
    pub build_config: BuildConfig,
    pub features: Vec<String>,
    pub all_features: bool,
    pub no_default_features: bool,
    pub spec: Packages,
    pub filter: CompileFilter,
    pub target_rustdoc_args: Option<Vec<String>>,
    pub target_rustc_args: Option<Vec<String>>,
    pub local_rustdoc_args: Option<Vec<String>>,
    pub rustdoc_document_private_items: bool,
    pub honor_rust_version: bool,
}

Contains information about how a package should be compiled.

Note on distinction between CompileOptions and BuildConfig: BuildConfig contains values that need to be retained after BuildContext is created. The other fields are no longer necessary. Think of it as CompileOptions are high-level settings requested on the command-line, and BuildConfig are low-level settings for actually driving rustc.

Fields

build_config: BuildConfig

Configuration information for a rustc build

features: Vec<String>

Extra features to build for the root package

all_features: bool

Flag whether all available features should be built for the root package

no_default_features: bool

Flag if the default feature should be built for the root package

spec: Packages

A set of packages to build.

filter: CompileFilter

Filter to apply to the root package to select which targets will be built.

target_rustdoc_args: Option<Vec<String>>

Extra arguments to be passed to rustdoc (single target only)

target_rustc_args: Option<Vec<String>>

The specified target will be compiled with all the available arguments, note that this only accounts for the final invocation of rustc

local_rustdoc_args: Option<Vec<String>>

Extra arguments passed to all selected targets for rustdoc.

rustdoc_document_private_items: bool

Whether the --document-private-items flags was specified and should be forwarded to rustdoc.

honor_rust_version: bool

Whether the build process should check the minimum Rust version defined in the cargo metadata for a crate.

Implementations

impl<'a> CompileOptions

pub fn new(config: &Config, mode: CompileMode) -> CargoResult<CompileOptions>

Trait Implementations

impl Debug for CompileOptions

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

Formats the value using the given formatter.