Struct FeatureQuery

pub struct FeatureQuery<'g> { /* private fields */ }

A query over a feature graph.

A FeatureQuery is the entry point for Cargo resolution, and also provides iterators over feature IDs and links. This struct is constructed through the query_ methods on FeatureGraph, or through PackageQuery::to_feature_query.

Implementations

impl<'g> FeatureQuery<'g>

pub fn graph(&self) -> &FeatureGraph<'g>

Returns the feature graph the query is going to be executed on.

pub fn direction(&self) -> DependencyDirection

Returns the direction the query is happening in.

pub fn initials<'a>( &'a self, ) -> impl Iterator<Item = FeatureMetadata<'g>> + ExactSizeIterator + 'a

Returns the list of initial features specified in the query.

The order of features is unspecified.

pub fn initial_packages<'a>( &'a self, ) -> impl Iterator<Item = PackageMetadata<'g>> + 'a

Returns the list of initial packages specified in the query.

The order of packages is unspecified.

pub fn starts_from_package(&self, package_id: &PackageId) -> Result<bool, Error>

Returns true if the query starts from the given package.

Returns an error if the package ID is unknown.

pub fn starts_from<'a>( &self, feature_id: impl Into<FeatureId<'a>>, ) -> Result<bool, Error>

Returns true if the query starts from the given feature ID.

Returns an error if this feature ID is unknown.

pub fn resolve(self) -> FeatureSet<'g>

Resolves this query into a set of known feature IDs.

This is the entry point for iterators.

pub fn resolve_with(self, resolver: impl FeatureResolver<'g>) -> FeatureSet<'g>

Resolves this query into a set of known feature IDs, using the provided resolver to determine which links are followed.

pub fn resolve_with_fn( self, resolver_fn: impl FnMut(&FeatureQuery<'g>, ConditionalLink<'g>) -> bool, ) -> FeatureSet<'g>

Resolves this query into a set of known feature IDs, using the provided resolver function to determine which links are followed.

Trait Implementations

impl<'g> Clone for FeatureQuery<'g>

fn clone(&self) -> FeatureQuery<'g>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for FeatureQuery<'g>

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

Formats the value using the given formatter.