Trait Neighbors 

pub trait Neighbors: GraphBase {
    type NeighborRef<'a>: NeighborReference<Self::VertexId, Self::EdgeId>
       where Self: 'a;
    type NeighborsIter<'a>: Iterator<Item = Self::NeighborRef<'a>>
       where Self: 'a;

    // Required methods
    fn neighbors_undirected(
        &self,
        from: &Self::VertexId,
    ) -> Self::NeighborsIter<'_>;
    fn neighbors_directed(
        &self,
        from: &Self::VertexId,
        dir: Direction,
    ) -> Self::NeighborsIter<'_>;

    // Provided methods
    fn degree_undirected(&self, id: &Self::VertexId) -> usize { ... }
    fn degree_directed(&self, id: &Self::VertexId, dir: Direction) -> usize { ... }
}

Trait for traversing vertex neighbors in a graph.

Implementation notes

Required Associated Types

type NeighborRef<'a>: NeighborReference<Self::VertexId, Self::EdgeId> where Self: 'a

Reference to a neighbor.

type NeighborsIter<'a>: Iterator<Item = Self::NeighborRef<'a>> where Self: 'a

Iterator over neighbors of a vertex.

Required Methods

fn neighbors_undirected(&self, from: &Self::VertexId) -> Self::NeighborsIter<'_>

Returns all neighbors of the given vertex, regardless of edge direction.

In directed graphs, this means outgoing as well as incoming edges.

Panics

Panics if the vertex does not exist.

fn neighbors_directed( &self, from: &Self::VertexId, dir: Direction, ) -> Self::NeighborsIter<'_>

Returns all neighbors of the given vertex in the given direction.

In undirected graphs the edge direction is ignored and the returned items are the same as from neighbors_undirected.

Panics

Panics if the vertex does not exist.

Provided Methods

fn degree_undirected(&self, id: &Self::VertexId) -> usize

Returns the total degree of the given vertex.

Panics

Panics if the vertex does not exist.

fn degree_directed(&self, id: &Self::VertexId, dir: Direction) -> usize

Returns the out or in degree of the given vertex, depending on the edge direction argument.

In undirected graphs the direction is ignored and the returned value is the same as from degree_undirected.

Panics

Panics if the vertex does not exist.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<G> Neighbors for &G

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = <G as Neighbors>::NeighborsIter<'a> where Self: 'a

fn neighbors_undirected(&self, from: &Self::VertexId) -> Self::NeighborsIter<'_>

fn neighbors_directed( &self, from: &Self::VertexId, dir: Direction, ) -> Self::NeighborsIter<'_>

fn degree_undirected(&self, id: &Self::VertexId) -> usize

fn degree_directed(&self, id: &Self::VertexId, dir: Direction) -> usize

impl<G> Neighbors for &mut G

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = <G as Neighbors>::NeighborsIter<'a> where Self: 'a

fn neighbors_undirected(&self, from: &Self::VertexId) -> Self::NeighborsIter<'_>

fn neighbors_directed( &self, from: &Self::VertexId, dir: Direction, ) -> Self::NeighborsIter<'_>

fn degree_undirected(&self, id: &Self::VertexId) -> usize

fn degree_directed(&self, id: &Self::VertexId, dir: Direction) -> usize

Implementors

impl<E, G> Neighbors for Complement<E, G>

where G: Neighbors + VertexSet, G::EdgeId: IntegerIdType,

type NeighborRef<'a> = NeighborRef<<G as GraphBase>::VertexId, <G as GraphBase>::EdgeId> where Self: 'a

type NeighborsIter<'a> = NeighborsIter<'a, G> where Self: 'a

impl<G> Neighbors for CastAsDirected<G>

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = <G as Neighbors>::NeighborsIter<'a> where Self: 'a

impl<G> Neighbors for CastAsUndirected<G>

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = <G as Neighbors>::NeighborsIter<'a> where Self: 'a

impl<G> Neighbors for Transpose<G>

where G: Neighbors,

type NeighborRef<'a> = TransposeRef<<G as Neighbors>::NeighborRef<'a>> where Self: 'a

type NeighborsIter<'a> = Iter<<G as Neighbors>::NeighborsIter<'a>> where Self: 'a

impl<G> Neighbors for Undirect<G>

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = <G as Neighbors>::NeighborsIter<'a> where Self: 'a

impl<G> Neighbors for Stable<G>

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = NeighborsIter<'a, G> where Self: 'a

impl<G, S> Neighbors for Subgraph<G, S>

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = SubgraphIter<'a, <G as Neighbors>::NeighborsIter<'a>, <G as Neighbors>::NeighborRef<'a>> where Self: 'a

impl<V, E, N, F, Ty: EdgeType> Neighbors for Implicit<V, E, N, F, Ty>

where N: IntoIterator<Item = (V, E)>, F: Fn(&V) -> N, ImplicitId<V>: IdType, ImplicitId<E>: IdType,

type NeighborRef<'a> = NeighborRef<ImplicitId<V>, ImplicitId<E>> where Self: 'a

type NeighborsIter<'a> = NeighborsIter<V, E, <N as IntoIterator>::IntoIter> where Self: 'a

impl<V, E, Ty: EdgeType, G> Neighbors for Graph<V, E, Ty, G>

where G: Neighbors,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = <G as Neighbors>::NeighborsIter<'a> where Self: 'a

impl<V, E, Ty: EdgeType, G> Neighbors for Path<V, E, Ty, G>

where G: Neighbors + GraphBase,

type NeighborRef<'a> = <G as Neighbors>::NeighborRef<'a> where Self: 'a

type NeighborsIter<'a> = <G as Neighbors>::NeighborsIter<'a> where Self: 'a

impl<V, E, Ty: EdgeType, Id: IdPair> Neighbors for AdjList<V, E, Ty, Id>

where Id::VertexId: IntegerIdType, Id::EdgeId: IntegerIdType,

type NeighborRef<'a> = NeighborRef<<AdjList<V, E, Ty, Id> as GraphBase>::VertexId, <AdjList<V, E, Ty, Id> as GraphBase>::EdgeId> where Self: 'a

type NeighborsIter<'a> = NeighborsIter<'a, Ty, Id> where Self: 'a

impl<V, E, Ty: EdgeType, Id: IdPair> Neighbors for AdjMatrix<V, E, Ty, Id>

where Id::VertexId: IntegerIdType, Id::EdgeId: IntegerIdType,

type NeighborRef<'a> = NeighborRef<<AdjMatrix<V, E, Ty, Id> as GraphBase>::VertexId, <AdjMatrix<V, E, Ty, Id> as GraphBase>::EdgeId> where Self: 'a

type NeighborsIter<'a> = NeighborsIter<'a, Ty, Id> where Self: 'a

impl<V, E, Ty: EdgeType, Id: IdPair> Neighbors for EdgeList<V, E, Ty, Id>

where Id::VertexId: IntegerIdType, Id::EdgeId: IntegerIdType,

type NeighborRef<'a> = NeighborRef<<EdgeList<V, E, Ty, Id> as GraphBase>::VertexId, <EdgeList<V, E, Ty, Id> as GraphBase>::EdgeId> where Self: 'a

type NeighborsIter<'a> = NeighborsIter<'a, Ty, Id> where Self: 'a