Struct forest_ds::cursor::Cursor

pub struct Cursor<'a, T> { /* private fields */ }

Cursor over the tree elements.

If a move operation fails we Return a result with:

• Ok: the moved cursor
• Err: the previous unmodified cursor

Implementations

impl<T> Cursor<'_, T>

pub fn id(&self) -> NodeId

pub fn get(&self) -> &T

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

pub fn parent(&mut self) -> Result<&mut Self, &mut Self>

Move the cursor to the parent

Errors

If there is no next node will return the previous position

pub fn first_child(&mut self) -> Result<&mut Self, &mut Self>

Move the cursor to the first child

Errors

If there is no next node will return the previous position

pub fn last_child(&mut self) -> Result<&mut Self, &mut Self>

Move the cursor to the last child

Errors

If there is no next node will return the previous position

pub fn next_sibling(&mut self) -> Result<&mut Self, &mut Self>

Move the cursor to the next sibling

Errors

If there is no next node will return the previous position

pub fn prev_sibling(&mut self) -> Result<&mut Self, &mut Self>

Move the cursor to the prev sibling

Errors

If there is no next node will return the previous position

pub fn move_next(&mut self) -> Result<&mut Self, &mut Self>

Move the cursor to the next node

Errors

If there is no next node will return the previous position

pub fn append_child(&mut self, value: T) -> NodeId

pub fn append_sibling(&mut self, value: T) -> NodeId

pub fn peek_parent(&self) -> Option<&T>

pub fn peek_next_sibling(&self) -> Option<&T>

pub fn peek_prev_sibling(&self) -> Option<&T>

pub fn peek_first_child(&self) -> Option<&T>

pub fn peek_last_child(&self) -> Option<&T>

Trait Implementations

impl<'a, T: Debug> Debug for Cursor<'a, T>

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

Formats the value using the given formatter.