Struct tree_flat::tree::Tree

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

Vec-backed, flattened in pre-order, Tree.

Always contains at least a root node.

Implementations

impl<T: Debug> Tree<T>

pub fn new(root: T) -> Self

Create a new Tree with the specified value

pub fn with_capacity(root: T, capacity: usize) -> Self

Create a new Tree with the specified value & set the capacity of the internal vectors

pub fn push_with_level(&mut self, data: T, level: usize, parent: NodeId) -> NodeId

Push a node into the tree

#WARNING

This assumes you are pushing in pre-order!

pub fn tree_root_mut(&mut self) -> TreeMut<'_, T>

Get a mutable TreeMut handle of the root, so you can push children

This always success

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

Get a mutable TreeMut from his NodeId, so you can push children

pub fn node(&self, id: NodeId) -> Option<Node<'_, T>>

Get the Node from his NodeId

pub fn root(&self) -> Node<'_, T>

Get the root Node

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

Get a mutable NodeMut from his NodeId.

pub fn root_mut(&mut self) -> NodeMut<'_, T>

Get a mutable NodeMut handle of the root.

This always success

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

pub fn into_iter(&self) -> IntoIter<'_, T>

pub fn as_data(&self) -> &[T]

A slice view of the internal data

pub fn as_data_mut(&mut self) -> &mut [T]

A slice view of the internal data

pub fn as_level(&self) -> &[usize]

A slice view of the internal level

pub fn get_level(&self, of: NodeId) -> usize

Get the level from a NodeId

pub fn as_parents(&self) -> &[usize]

A slice view of the internal parents

pub fn to_data(self) -> Vec<T>

Consume tree and move-out the data

pub fn print(&self, f: &mut Formatter<'_>) -> Resultwhere
    T: Display,

Pretty-print the tree

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: Debug + Display> Display for Tree<T>

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

Formats the value using the given formatter.

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

type Item = Node<'a, T>

The type of the elements being iterated over.

type IntoIter = TreeIter<'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: Ord> Ord for Tree<T>

fn cmp(&self, other: &Tree<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Tree<T>> for Tree<T>

fn eq(&self, other: &Tree<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd<Tree<T>> for Tree<T>

fn partial_cmp(&self, other: &Tree<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for Tree<T>

impl<T> StructuralEq for Tree<T>

impl<T> StructuralPartialEq for Tree<T>