Enum petgraph::visit::Control

pub enum Control<B> {
    Continue,
    Prune,
    Break(B),
}

Control flow for depth_first_search callbacks.

Variants

Continue

Continue the DFS traversal as normal.

Prune

Prune the current node from the DFS traversal. No more edges from this node will be reported to the callback. A DfsEvent::Finish for this node will still be reported. This can be returned in response to any DfsEvent, except Finish, which will panic.

Break(B)

Stop the DFS traversal and return the provided value.

Implementations

impl<B> Control<B>

pub fn breaking() -> Control<()>

pub fn break_value(self) -> Option<B>

Get the value in Control::Break(_), if present.

Trait Implementations

impl<B: Clone> Clone for Control<B>

fn clone(&self) -> Control<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> ControlFlow for Control<B>

fn continuing() -> Self

fn should_break(&self) -> bool

fn should_prune(&self) -> bool

impl<B: Debug> Debug for Control<B>

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

Formats the value using the given formatter.

impl<B> Default for Control<B>

The default is Continue.

fn default() -> Self

Returns the “default value” for a type.

impl<B: Copy> Copy for Control<B>