Struct DecyclerGuard

pub(crate) struct DecyclerGuard<'a, T, const D: usize> {
    decycler: &'a mut Decycler<T, D>,
}

Fields

decycler: &'a mut Decycler<T, D>

Methods from Deref<Target = Decycler<T, D>>

pub fn enter( &mut self, node_id: T, ) -> Result<DecyclerGuard<'_, T, D>, DecyclerError>

Enters a new graph node with the given value that uniquely identifies the current node.

Returns an error when a cycle is detected or the max depth of the traversal is exceeded. Otherwise, increases the current depth and returns a guard object that will decrease the depth when dropped.

The guard object derefs to the decycler, so it can be passed to a recursive traversal function to check for cycles in descendent nodes in a graph.

Trait Implementations

impl<T, const D: usize> Deref for DecyclerGuard<'_, T, D>

type Target = Decycler<T, D>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, const D: usize> DerefMut for DecyclerGuard<'_, T, D>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, const D: usize> Drop for DecyclerGuard<'_, T, D>

fn drop(&mut self)

Executes the destructor for this type.