Struct guppy::graph::PackageSelect

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

A selector over a package graph.

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

Methods

impl<'g> PackageSelect<'g>

pub fn into_dot<V>(self, visitor: V) -> impl Display + 'g where
    V: 'g + PackageDotVisitor, 

Constructs a representation of the selected graph in dot format.

impl<'g> PackageSelect<'g>

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

Returns the set of "root packages" 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.

Important traits for IntoIterIds<'g>

impl<'g> Iterator for IntoIterIds<'g> type Item = &'g PackageId;

pub fn into_iter_ids(
    self,
    direction_opt: Option<DependencyDirection>
) -> IntoIterIds<'g>

Consumes this query and creates an iterator over package IDs, returned in topological order.

The default order of iteration is determined by the type of query:

• for all and transitive_deps queries, package IDs are returned in forward order.
• for transitive_reverse_deps queries, package IDs are returned in reverse order.

Important traits for IntoIterMetadatas<'g>

impl<'g> Iterator for IntoIterMetadatas<'g> type Item = &'g PackageMetadata;

pub fn into_iter_metadatas(
    self,
    direction_opt: Option<DependencyDirection>
) -> IntoIterMetadatas<'g>

Consumes this query and creates an iterator over PackageMetadata instances, returned in topological order.

The default order of iteration is determined by the type of query:

• for all and transitive_deps queries, packages are returned in forward order.
• for transitive_reverse_deps queries, packages are returned in reverse order.

Important traits for IntoIterLinks<'g>

impl<'g> Iterator for IntoIterLinks<'g> type Item = DependencyLink<'g>;

pub fn into_iter_links(
    self,
    direction_opt: Option<DependencyDirection>
) -> IntoIterLinks<'g>

Consumes this query and creates an iterator over dependency links.

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.

The default order of iteration is determined by the type of query:

• for all and transitive_deps queries, package IDs are returned in forward order.
• for transitive_reverse_deps queries, package IDs are returned in reverse order.

Trait Implementations

impl<'g> Clone for PackageSelect<'g>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for PackageSelect<'g>

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

Formats the value using the given formatter.