Struct Vertex

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

An internal type that stores the payload and relationships of a node in a Tree<T> or PolyTree<T>.

Every node on the tree is represented by a Vertex<T>. The len field stores the number of descendants the node has; this is the number of nodes in the subtree below the node. A leaf node has length 0.

Every Tree<T> contains a Vec<Vertex<T>> representing the trees nodes in a depth first order; meaning every vertex is followed by its first child. This makes it very easy to take a slice of the vertex buffer that represents a subtree. We expose such a slice to the user as a Node<T>.

The type implements Clone and Copy as long as the payload T implements the same. Supporting Copy is important to ensure Vec::extend_from_slice executes as fast as possible. This method is used by Sapling::push_tree to copy the nodes of a tree into another sapling.

Implementations

impl<T> Vertex<T>

pub fn new(data: T, len: usize) -> Self

Returns a new vertex with payload data intending to own len many descendants.

Trait Implementations

impl<T: Clone> Clone for Vertex<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Vertex<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Vertex<T>