Struct MutCursorVec

pub struct MutCursorVec<'root, T: ?Sized + 'root> { /* private fields */ }

Available on crate feature alloc only.

Similar to MutCursor, but allows for a dynamically growing stack

MutCursorVec is not available if the alloc feature is disabled. (The feature is enabled by default.)

Implementations

impl<'root, T: ?Sized + 'root> MutCursorVec<'root, T>

pub fn new(root: &'root mut T) -> Self

Returns a new MutCursorVec with a reference to the specified root

pub fn new_with_capacity(root: &'root mut T, capacity: usize) -> Self

Returns a new MutCursorVec with a reference to the specified root, and an allocated buffer for capacity references

pub fn top(&self) -> &T

Returns a const reference from the mutable reference on the top of the stack

pub fn top_mut(&mut self) -> &mut T

Returns the mutable reference on the top of the stack

pub fn into_mut(self) -> &'root mut T

Returns the mutable reference on the top of the stack, consuming the stack

pub fn try_map_into_mut<U, E, F>(self, f: F) -> Result<&'root mut U, (Self, E)>

where for<'r> F: FnOnce(&'r mut T) -> Result<&'r mut U, E>,

Consumes the stack and returns a mutable reference to an object with the 'root lifetime, if a closure returns Ok, otherwise returns the stack and a custom error value

NOTE: Usage is identical to MutCursor::try_map_into_mut

pub fn depth(&self) -> usize

Returns the number of excess references stored in the stack, which corresponds to the number of times backtrack may be called

pub fn capacity(&self) -> usize

Returns the number of references the stack is capable of holding without reallocation

pub fn advance<F>(&mut self, step_f: F) -> bool

where F: FnOnce(&mut T) -> Option<&mut T>,

Steps deeper into the traversal, pushing a new reference onto the top of the stack

If the step_f closure returns Some(), the contained reference is pushed onto the stack and this method returns true. If the closure returns None then the stack is unmodified and this method returns false.

pub fn backtrack(&mut self)

Pops a reference from the stack, exposing the prior reference as the new top

This method will panic if the stack contains only 1 entry

pub fn to_root(&mut self)

Pops all references from the stack, exposing the root reference as the top

This method does nothing if the stack is already at the root

Trait Implementations

impl<'root, T: ?Sized> Deref for MutCursorVec<'root, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'root, T: ?Sized> DerefMut for MutCursorVec<'root, T>

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

Mutably dereferences the value.

impl<'a, T> Send for MutCursorVec<'a, T>

where T: Send + ?Sized,

impl<'a, T> Sync for MutCursorVec<'a, T>

where T: Sync + ?Sized,