Struct read_tree::Node

pub struct Node<'a, T> { /* fields omitted */ }

A slice of a Tree.

A node is essentially the same as a tree, only that it does not own its data. You can navigate a node using iterators.

Methods

impl<'a, T> Node<'a, T>

pub fn data(&self) -> &T

Returns a reference to the payload of the node.

pub fn depth(&self) -> usize

Returns the depth of the node within the tree. The root node returns depth 0.

pub fn len(&self) -> usize

Returns the number of nodes within the subtree of this node.

The count includes the node itself; a leaf node returns length 1.

pub fn is_leaf(&self) -> bool

Returns true if the node has no child nodes.

Important traits for Descendants<'a, T>

impl<'a, T> Iterator for Descendants<'a, T> type Item = Node<'a, T>;

pub fn iter(&self) -> Descendants<'a, T>

Returns a depth first iterator of nodes. It iterates all nodes in the subtree of the node, including the node itself. See Descendants for more information.

Important traits for Children<'a, T>

impl<'a, T> Iterator for Children<'a, T> type Item = Node<'a, T>;

pub fn children(&self) -> Children<'a, T>

Returns an iterator over the child nodes of the node. See Children for more information.

impl<'a, T: Clone> Node<'a, T>

pub fn into_tree(self) -> Tree<T>

Clones the subtree of the node into a new tree.

This step may be expensive and should be avoided if possible.

Trait Implementations

impl<'a, T: Debug> Debug for Node<'a, T>

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

Formats the value using the given formatter.