petgraph::visit

Enum Control

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

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§

Source§

impl<B> Control<B>

Source

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

Source

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

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

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<B> ControlFlow for Control<B>

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<B> Default for Control<B>

The default is Continue.

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Auto Trait Implementations§

§

impl<B> Freeze for Control<B>
where B: Freeze,

§

impl<B> RefUnwindSafe for Control<B>
where B: RefUnwindSafe,

§

impl<B> Send for Control<B>
where B: Send,

§

impl<B> Sync for Control<B>
where B: Sync,

§

impl<B> Unpin for Control<B>
where B: Unpin,

§

impl<B> UnwindSafe for Control<B>
where B: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.