Struct GenTree

pub struct GenTree<T> { /* private fields */ }

The GenTree struct represents a positional, linked-based general tree structure that contains a pointer to the root node and the structure’s size. The genericity of the struct means you’ll have to explicitly type the tree at instantiation.

Most of the major accessors and mutators appear on the CursorMut struct.

Example:

    // Creates a tree over Heading objects
    let mut tree: GenTree<Heading> = GenTree::<Heading>::new();

    // Creates a CursorMut to navigate/mutate the tree,
    // starting at the root node
    let mut cursor = tree.cursor_mut();

Implementations

impl<T> GenTree<T>

pub fn new() -> GenTree<T>

Instantiates a new GenTree.

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

Returns the Position of the tree’s root.

pub fn cursor_mut(&mut self) -> CursorMut<'_, T>

Creates a CursorMut starting at the tree’s root.

pub fn cursor_from(&mut self, position: Position<T>) -> CursorMut<'_, T>

Creates a CursorMut from a given Position.

Trait Implementations

impl<T: Debug> Debug for GenTree<T>

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

Formats the value using the given formatter.

impl<T> Default for GenTree<T>

fn default() -> Self

Returns the “default value” for a type.