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
sourceimpl<'g> PackageSet<'g>
impl<'g> PackageSet<'g>
sourcepub fn contains(&self, package_id: &PackageId) -> Result<bool, Error>
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.
sourcepub fn to_package_query(
&self,
direction: DependencyDirection
) -> PackageQuery<'g>
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
.
sourcepub fn union(&self, other: &Self) -> Self
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.
sourcepub fn intersection(&self, other: &Self) -> Self
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.
sourcepub fn difference(&self, other: &Self) -> Self
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.
sourcepub fn symmetric_difference(&self, other: &Self) -> Self
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.
sourcepub fn filter(
&self,
direction: DependencyDirection,
callback: impl FnMut(PackageMetadata<'g>) -> bool
) -> Self
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.
sourcepub fn partition(
&self,
direction: DependencyDirection,
callback: impl FnMut(PackageMetadata<'g>) -> bool
) -> (Self, Self)
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.
sourcepub fn filter_partition(
&self,
direction: DependencyDirection,
callback: impl FnMut(PackageMetadata<'g>) -> Option<bool>
) -> (Self, Self)
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.
sourcepub fn to_feature_set(&self, filter: impl FeatureFilter<'g>) -> FeatureSet<'g>
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.
sourcepub fn package_ids<'a>(
&'a self,
direction: DependencyDirection
) -> impl Iterator<Item = &'g PackageId> + ExactSizeIterator + 'a
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.
sourcepub fn packages<'a>(
&'a self,
direction: DependencyDirection
) -> impl Iterator<Item = PackageMetadata<'g>> + ExactSizeIterator + 'a
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.
sourcepub fn root_ids<'a>(
&'a self,
direction: DependencyDirection
) -> impl Iterator<Item = &'g PackageId> + ExactSizeIterator + 'a
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).
sourcepub fn root_packages<'a>(
&'a self,
direction: DependencyDirection
) -> impl Iterator<Item = PackageMetadata<'g>> + ExactSizeIterator + 'a
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).
sourcepub fn links<'a>(
&'a self,
direction: DependencyDirection
) -> impl Iterator<Item = PackageLink<'g>> + 'a
pub fn links<'a>(
&'a self,
direction: DependencyDirection
) -> impl Iterator<Item = PackageLink<'g>> + 'a
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.
sourcepub fn display_dot<'a, V: PackageDotVisitor + 'g>(
&'a self,
visitor: V
) -> impl Display + 'a
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.
sourceimpl<'g> PackageSet<'g>
impl<'g> PackageSet<'g>
sourcepub fn to_summary(&self) -> PackageSetSummary
Available on crate feature summaries
only.
pub fn to_summary(&self) -> PackageSetSummary
summaries
only.Converts this PackageSet
to a serializable PackageSetSummary
.
Trait Implementations
sourceimpl<'g> Clone for PackageSet<'g>
impl<'g> Clone for PackageSet<'g>
sourcefn clone(&self) -> PackageSet<'g>
fn clone(&self) -> PackageSet<'g>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'g> Debug for PackageSet<'g>
impl<'g> Debug for PackageSet<'g>
sourceimpl<'g> PartialEq<PackageSet<'g>> for PackageSet<'g>
impl<'g> PartialEq<PackageSet<'g>> for PackageSet<'g>
impl<'g> Eq for PackageSet<'g>
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more