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>

source

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

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

source

pub fn direction(&self) -> DependencyDirection

Returns the direction the query is happening in.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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>

source§

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

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<'g> Debug for PackageQuery<'g>

source§

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

Formats the value using the given formatter. Read more

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

default 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.

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> ToOwned for T
where 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 T
where U: Into<T>,

§

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>,

§

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.