# Struct cargo::ops::CompileOptions

source ·

    pub struct CompileOptions {
        pub build_config: BuildConfig,
        pub cli_features: CliFeatures,
        pub spec: Packages,
        pub filter: CompileFilter,
        pub target_rustdoc_args: Option<Vec<String>>,
        pub target_rustc_args: Option<Vec<String>>,
        pub target_rustc_crate_types: Option<Vec<String>>,
        pub rustdoc_document_private_items: bool,
        pub honor_rust_version: Option<bool>,
    }

Expand description

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

§`cli_features: CliFeatures`

Feature flags requested by the user.

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

§`target_rustc_crate_types: Option<Vec<String>>`

Crate types to be passed to rustc (single target only)

§`rustdoc_document_private_items: bool`

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

§`honor_rust_version: Option<bool>`

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

## Implementations§

source§

### impl CompileOptions

source

#### pub fn new( gctx: &GlobalContext, mode: CompileMode, ) -> CargoResult<CompileOptions>

## Trait Implementations§

source§

### impl Clone for CompileOptions

source§

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

Returns a copy 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 CompileOptions

source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl Freeze for CompileOptions

§

### impl !RefUnwindSafe for CompileOptions

§

### impl !Send for CompileOptions

§

### impl !Sync for CompileOptions

§

### impl Unpin for CompileOptions

§

### impl !UnwindSafe for CompileOptions

## 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, dst: *mut T)

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

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