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(super) fn enter( &mut self, node_id: T, ) -> Result<DecyclerGuard<'_, T, D>, DecyclerError>

Enters the node uniquely identified by node_id.

Returns an error if a cycle is detected or the depth limit is reached. Otherwise, increases the depth and returns a guard that decreases it when dropped.

The guard dereferences to the decycler, so a recursive traversal can pass it down to check child nodes.

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.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.