Enum cargo::ops::CompileFilter

source ·
pub enum CompileFilter {
    Default {
        required_features_filterable: bool,
    },
    Only {
        all_targets: bool,
        lib: LibRule,
        bins: FilterRule,
        examples: FilterRule,
        tests: FilterRule,
        benches: FilterRule,
    },
}
Expand description

Filter to apply to the root package to select which Cargo targets will be built. (examples, bins, benches, tests, …)

The actual filter process happens inside generate_root_units.

Not to be confused with Packages, which opts in packages to be built.

Variants§

§

Default

Fields

§required_features_filterable: bool

Flag whether targets can be safely skipped when required-features are not satisfied.

The default set of Cargo targets.

§

Only

Fields

§all_targets: bool

Include all Cargo targets.

§examples: FilterRule
§benches: FilterRule

Only includes a subset of all Cargo targets.

Implementations§

source§

impl CompileFilter

source

pub fn from_raw_arguments( lib_only: bool, bins: Vec<String>, all_bins: bool, tsts: Vec<String>, all_tsts: bool, exms: Vec<String>, all_exms: bool, bens: Vec<String>, all_bens: bool, all_targets: bool ) -> CompileFilter

Constructs a filter from raw command line arguments.

source

pub fn new( rule_lib: LibRule, rule_bins: FilterRule, rule_tsts: FilterRule, rule_exms: FilterRule, rule_bens: FilterRule ) -> CompileFilter

Constructs a filter from underlying primitives.

source

pub fn new_all_targets() -> CompileFilter

Constructs a filter that includes all targets.

source

pub fn all_test_targets() -> Self

Constructs a filter that includes all test targets.

Being different from the behavior of CompileFilter::Default, this function only recognizes test targets, which means cargo might compile all targets with tested flag on, whereas CompileFilter::Default may include additional example targets to ensure they can be compiled.

Note that the actual behavior is subject to filter_default_targets and generate_root_units though.

source

pub fn lib_only() -> Self

Constructs a filter that includes lib target only.

source

pub fn single_bin(bin: String) -> Self

Constructs a filter that includes the given binary. No more. No less.

source

pub fn need_dev_deps(&self, mode: CompileMode) -> bool

Indicates if Cargo needs to build any dev dependency.

source

pub fn target_run(&self, target: &Target) -> bool

Selects targets for “cargo run”. for logic to select targets for other subcommands, see generate_root_units and filter_default_targets.

source

pub fn is_specific(&self) -> bool

source

pub fn is_all_targets(&self) -> bool

Trait Implementations§

source§

impl Clone for CompileFilter

source§

fn clone(&self) -> CompileFilter

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 CompileFilter

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · 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> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.