Struct CursorMut

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

A cursor over mutable Node data with safe, reference-counted Position handles.

This struct represents the majority of major operations for the GenTree structure. All operations run in O(1) time unless otherwise noted.

Implementations

impl<'a, T> CursorMut<'a, T>

pub fn is_root(&self) -> bool

Returns true if the Node under the curosr is the tree’s root

pub fn is_some(&self) -> bool

Returns true if the Node under the curosr has data

pub fn is_none(&self) -> bool

Returns true if the Node under the cursor is empty

pub fn num_children(&self) -> usize

Returns the number of children for the Node under the cursor as usize

pub fn depth(&self) -> usize

Returns the depth of the cursor from the tree’s root

pub fn height(&self) -> usize

Returns the height of the tallest sub-tree for the current position ** The recursive guts of the height function */

pub fn get_data(&self) -> Option<Ref<'_, T>>

Returns an immutable reference to the data under the cursor, if Some

pub fn get_for_pos(&'a self, pos: &'a Position<T>) -> Option<Ref<'a, T>>

Returns an immutable reference to the data for a supplied Position

pub fn add_child(&mut self, data: T)

Adds a new child Node under the current cursor and advances the cursor to the new child

pub fn children(&self) -> Vec<Position<T>>

Returns a list of owned descendant (child) Positions for the Node under the cursor in O(c) time where c is the number of children; The clone used here is a cheap pointer copy, not an underlying data copy

pub fn delete(&mut self) -> Option<T>

Warning: Broken! Does not handle root deletion properly.

Removes the node at the current cursor position and returns its data, if Some. Operation executes in O(c) time where c is the number of children for the given node; Adds all children to the parent (if Some), and returns the deleted Node; If the cursor is at the tree’s root, this just deletes the Node’s data, leaving None; Moves the cursor to the parent, if Some */

pub fn current(&self) -> &Position<T>

Returns a reference to the current Position

pub fn jump(&mut self, new: &Position<T>)

Jump the cursor to the given Position

pub fn ascend(&mut self) -> Result<(), String>

Moves the cursor up a generation, if Some; Trying to ascend past the root results in an error