Struct guppy::graph::PackageQuery
source · pub struct PackageQuery<'g> { /* private fields */ }Expand description
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§
source§impl<'g> PackageQuery<'g>
impl<'g> PackageQuery<'g>
sourcepub fn graph(&self) -> &'g PackageGraph
pub fn graph(&self) -> &'g PackageGraph
Returns the package graph on which the query is going to be executed.
sourcepub fn direction(&self) -> DependencyDirection
pub fn direction(&self) -> DependencyDirection
Returns the direction the query is happening in.
sourcepub fn initials<'a>(
&'a self,
) -> impl ExactSizeIterator<Item = PackageMetadata<'g>> + 'a
pub fn initials<'a>( &'a self, ) -> impl ExactSizeIterator<Item = PackageMetadata<'g>> + 'a
Returns the list of initial packages specified in the query.
The order of packages is unspecified.
sourcepub fn starts_from(&self, package_id: &PackageId) -> Result<bool, Error>
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.
sourcepub fn to_feature_query(
&self,
filter: impl FeatureFilter<'g>,
) -> FeatureQuery<'g>
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.
sourcepub fn resolve(self) -> PackageSet<'g>
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.
sourcepub fn resolve_with(self, resolver: impl PackageResolver<'g>) -> PackageSet<'g>
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.
sourcepub fn resolve_with_fn(
self,
resolver_fn: impl FnMut(&PackageQuery<'g>, PackageLink<'g>) -> bool,
) -> PackageSet<'g>
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§
source§impl<'g> Clone for PackageQuery<'g>
impl<'g> Clone for PackageQuery<'g>
source§fn clone(&self) -> PackageQuery<'g>
fn clone(&self) -> PackageQuery<'g>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl<'g> Freeze for PackageQuery<'g>
impl<'g> RefUnwindSafe for PackageQuery<'g>
impl<'g> Send for PackageQuery<'g>
impl<'g> Sync for PackageQuery<'g>
impl<'g> Unpin for PackageQuery<'g>
impl<'g> UnwindSafe for PackageQuery<'g>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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