Struct forest_ds::tree::Tree

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

Implementations

impl<T> Tree<T>

pub fn cursor(&mut self, id: &NodeId) -> Option<Cursor<'_, T>>

pub fn cursor_first(&mut self) -> Option<Cursor<'_, T>>

pub fn cursor_last(&mut self) -> Option<Cursor<'_, T>>

impl<T> Tree<T>

pub fn get(&self, id: &NodeId) -> Option<&T>

pub fn get_mut(&mut self, id: &NodeId) -> Option<&mut T>

impl<T> Tree<T>

pub fn iter(&self) -> Iter<'_, T>

pub fn iter_from(&self, id: &NodeId) -> Iter<'_, T>

pub fn iter_mut(&mut self) -> IterMut<'_, T>

pub fn into_iterator(self) -> IntoIter<T>

impl<T> Tree<T>

pub fn make_child(&mut self, child: &NodeId, parent: &NodeId) -> Result<(), Error>

Make the child nodes as the last child of the parent node.

Errors

• Fails of the same NodeId is passed
• TODO: Fail if the child node is parent of the parent node.

pub fn make_prev_siblings(
    &mut self,
    node: &NodeId,
    sibling: &NodeId
) -> Result<(), Error>

Make the node as the previous sibling of sibling

Errors

• Fails of the same NodeId is passed
• TODO: Fail if the child node is parent of the parent node.

pub fn make_next_siblings(
    &mut self,
    node: &NodeId,
    sibling: &NodeId
) -> Result<(), Error>

Make the node as the next sibling of sibling

Errors

• Fails of the same NodeId is passed
• TODO: Fail if the child node is parent of the parent node.

pub fn detach(&mut self, node: &NodeId) -> Result<(), Error>

Detach the node from it’s parent

Errors

• Fails of the node was removed

impl<T> Tree<T>

pub fn new() -> Self

Create a new tree.

pub fn with_capacity(capacity: usize) -> Self

Create a new tree with a specific parameter.

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

Add a node to the tree, without relations with the other nodes.

pub fn remove(&mut self, id: NodeId) -> Result<T, Error>

Remove a node.

If there are some children nodes, they will became the first node if we are removing the first node. Otherwise they will become orphan nodes.

It will consume the NodeId.

Errors

Fails if the NodeId is invalid.

pub fn first_node_id(&self) -> Option<NodeId>

pub fn last_node_id(&self) -> Option<NodeId>

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

Appends the value to the last element of the three as its child. If None creates a new root.

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

Appends the value to the last element of the three as its sibling. If None creates a new root.

pub fn append_child_to(&mut self, id: &NodeId, value: T) -> Result<NodeId, Error>

Appends a new node as child of the given one

Errors

Will error if the given node id was removed.

pub fn insert_sibling_after(
    &mut self,
    id: &NodeId,
    value: T
) -> Result<NodeId, Error>

Insert a new node after the as the sibling of the given one

Errors

Will error if the given node id was removed.

Trait Implementations

impl<T: Clone> Clone for Tree<T>

fn clone(&self) -> Tree<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Tree<T>

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

Formats the value using the given formatter.

impl<T> Default for Tree<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> IntoIterator for &'a Tree<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Tree<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.