Struct GraphQuery 

pub struct GraphQuery<'a, N, E>(pub &'a StableGraph<N, E>);

A wrapper for ascertaining the structure of the underlying graph. This type is used in forward_traverse_mut callbacks.

Tuple Fields

0: &'a StableGraph<N, E>

Implementations

impl<'a, N, E> GraphQuery<'a, N, E>

pub fn new(ir: &'a StableGraph<N, E>) -> Self

Creates a new GraphQuery from a reference to a StableGraph.

pub fn get_node(&self, x: NodeIndex) -> Option<&N>

Gets a node from its index.

pub fn neighbors_directed( &self, x: NodeIndex, direction: Direction, ) -> Neighbors<'_, E>

Gets information about the immediate parent or child nodes of the node at the given index.

Remarks

Direction::Outgoing gives children, while Direction::Incoming gives parents.

pub fn edges_directed( &self, x: NodeIndex, direction: Direction, ) -> Edges<'_, E, Directed>

Gets edges pointing at the parent or child nodes of the node at the given index.

Remarks

Direction::Outgoing gives children, while Direction::Incoming gives parents.

Trait Implementations

impl<'a, N, E> From<&'a StableGraph<N, E>> for GraphQuery<'a, N, E>

fn from(x: &'a StableGraph<N, E>) -> Self

Converts to this type from the input type.