Struct guppy::graph::PackageSet

source ·
pub struct PackageSet<'g> { /* private fields */ }
Expand description

A set of resolved packages in a package graph.

Created by PackageQuery::resolve.

Implementations§

source§

impl<'g> PackageSet<'g>

source

pub fn len(&self) -> usize

Returns the number of packages in this set.

source

pub fn is_empty(&self) -> bool

Returns true if no packages were resolved in this set.

source

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

Returns true if this package ID is contained in this resolve set.

Returns an error if the package ID is unknown.

source

pub fn to_package_query( &self, direction: DependencyDirection, ) -> PackageQuery<'g>

Creates a new PackageQuery from this set in the specified direction.

This is equivalent to constructing a query from all the package_ids.

source

pub fn union(&self, other: &Self) -> Self

Returns a PackageSet that contains all packages present in at least one of self and other.

§Panics

Panics if the package graphs associated with self and other don’t match.

source

pub fn intersection(&self, other: &Self) -> Self

Returns a PackageSet that contains all packages present in both self and other.

§Panics

Panics if the package graphs associated with self and other don’t match.

source

pub fn difference(&self, other: &Self) -> Self

Returns a PackageSet that contains all packages present in self but not other.

§Panics

Panics if the package graphs associated with self and other don’t match.

source

pub fn symmetric_difference(&self, other: &Self) -> Self

Returns a PackageSet that contains all packages present in exactly one of self and other.

§Panics

Panics if the package graphs associated with self and other don’t match.

source

pub fn filter( &self, direction: DependencyDirection, callback: impl FnMut(PackageMetadata<'g>) -> bool, ) -> Self

Returns a PackageSet on which a filter has been applied.

Filters out all values for which the callback returns false.

§Cycles

For packages within a dependency cycle, the callback will be called in non-dev order. When the direction is forward, if package Foo has a dependency on Bar, and Bar has a cyclic dev-dependency on Foo, then Foo is returned before Bar.

source

pub fn partition( &self, direction: DependencyDirection, callback: impl FnMut(PackageMetadata<'g>) -> bool, ) -> (Self, Self)

Partitions this PackageSet into two.

The first PackageSet contains packages for which the callback returned true, and the second one contains packages for which the callback returned false.

§Cycles

For packages within a dependency cycle, the callback will be called in non-dev order. When the direction is forward, if package Foo has a dependency on Bar, and Bar has a cyclic dev-dependency on Foo, then Foo is returned before Bar.

source

pub fn filter_partition( &self, direction: DependencyDirection, callback: impl FnMut(PackageMetadata<'g>) -> Option<bool>, ) -> (Self, Self)

Performs filtering and partitioning at the same time.

The first PackageSet contains packages for which the callback returned Some(true), and the second one contains packages for which the callback returned Some(false). Packages for which the callback returned None are dropped.

§Cycles

For packages within a dependency cycle, the callback will be called in non-dev order. When the direction is forward, if package Foo has a dependency on Bar, and Bar has a cyclic dev-dependency on Foo, then Foo is returned before Bar.

source

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

Creates a new FeatureSet consisting of all packages in this PackageSet, 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 package_ids<'a>( &'a self, direction: DependencyDirection, ) -> impl Iterator<Item = &'g PackageId> + ExactSizeIterator + 'a

Iterates over package IDs, in topological order in the direction specified.

§Cycles

The packages within a dependency cycle will be returned in non-dev order. When the direction is forward, if package Foo has a dependency on Bar, and Bar has a cyclic dev-dependency on Foo, then Foo is returned before Bar.

source

pub fn packages<'a>( &'a self, direction: DependencyDirection, ) -> impl Iterator<Item = PackageMetadata<'g>> + ExactSizeIterator + 'a

Iterates over package metadatas, in topological order in the direction specified.

§Cycles

The packages within a dependency cycle will be returned in non-dev order. When the direction is forward, if package Foo has a dependency on Bar, and Bar has a cyclic dev-dependency on Foo, then Foo is returned before Bar.

source

pub fn root_ids<'a>( &'a self, direction: DependencyDirection, ) -> impl Iterator<Item = &'g PackageId> + ExactSizeIterator + 'a

Returns the set of “root package” IDs in the specified direction.

  • If direction is Forward, return the set of packages that do not have any dependencies within the selected graph.
  • If direction is Reverse, return the set of packages that do not have any dependents within the selected graph.
§Cycles

If a root consists of a dependency cycle, all the packages in it will be returned in non-dev order (when the direction is forward).

source

pub fn root_packages<'a>( &'a self, direction: DependencyDirection, ) -> impl Iterator<Item = PackageMetadata<'g>> + ExactSizeIterator + 'a

Returns the set of “root package” metadatas in the specified direction.

  • If direction is Forward, return the set of packages that do not have any dependencies within the selected graph.
  • If direction is Reverse, return the set of packages that do not have any dependents within the selected graph.
§Cycles

If a root consists of a dependency cycle, all the packages in it will be returned in non-dev order (when the direction is forward).

Creates an iterator over PackageLink instances.

If the iteration is in forward order, for any given package, at least one link where the package is on the to end is returned before any links where the package is on the from end.

If the iteration is in reverse order, for any given package, at least one link where the package is on the from end is returned before any links where the package is on the to end.

§Cycles

The links in a dependency cycle will be returned in non-dev order. When the direction is forward, if package Foo has a dependency on Bar, and Bar has a cyclic dev-dependency on Foo, then the link Foo -> Bar is returned before the link Bar -> Foo.

source

pub fn display_dot<'a, V: PackageDotVisitor + 'g>( &'a self, visitor: V, ) -> impl Display + 'a

Constructs a representation of the selected packages in dot format.

Trait Implementations§

source§

impl<'g> Clone for PackageSet<'g>

source§

fn clone(&self) -> PackageSet<'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 PackageSet<'g>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'g> PartialEq for PackageSet<'g>

source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'g> Eq for PackageSet<'g>

Auto Trait Implementations§

§

impl<'g> Freeze for PackageSet<'g>

§

impl<'g> RefUnwindSafe for PackageSet<'g>

§

impl<'g> Send for PackageSet<'g>

§

impl<'g> Sync for PackageSet<'g>

§

impl<'g> Unpin for PackageSet<'g>

§

impl<'g> UnwindSafe for PackageSet<'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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.