Struct guppy::graph::PackageQuery

pub struct PackageQuery<'g> { /* fields omitted */ }

A query over a package graph.

This is the entry point for iterators over IDs and dependency links, and dot graph presentation. A PackageQuery is constructed through the query_ methods on PackageGraph.

Implementations

impl<'g> PackageQuery<'g>

pub fn graph(&self) -> &'g PackageGraph

Returns the package graph on which the query is going to be executed.

pub fn direction(&self) -> DependencyDirection

Returns the direction the query is happening in.

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

Returns the list of initial packages specified in the query.

The order of packages is unspecified.

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

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

Returns an error if this package ID is unknown.

pub fn to_feature_query(
    &self,
    filter: impl FeatureFilter<'g>
) -> FeatureQuery<'g>

Converts this PackageQuery into a FeatureQuery, using the given feature filter.

This will cause the feature graph to be constructed if it hasn’t been done so already.

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

Resolves this query into a set of known packages, following every link found along the way.

This is the entry point for iterators.

pub fn resolve_with(self, resolver: impl PackageResolver<'g>) -> PackageSet<'g>

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

pub fn resolve_with_fn(
    self,
    resolver_fn: impl FnMut(&PackageQuery<'g>, PackageLink<'g>) -> bool
) -> PackageSet<'g>

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

Trait Implementations

impl<'g> Clone for PackageQuery<'g>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for PackageQuery<'g>

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

Formats the value using the given formatter.