Struct Tree

pub struct Tree { /* private fields */ }

A builder for tree output. Construct using deviz::tree or deviz::text_tree.

Examples

let mut tree = deviz::tree("ast");
tree.begin_node();
tree.label("+");
{
    tree.begin_node();
    tree.label("1");
    tree.end_node();
}
{
    tree.begin_node();
    tree.label("2");
    tree.end_node();
}
tree.end_node();

Implementations

impl Tree

pub fn begin_node(&mut self)

Begin a new subtree, i.e. a node and all its children.

A call to this function should be paired with a call to end_node. Between these two calls, the node and its children should be built.

pub fn end_node(&mut self)

End a subtree. See begin_node.

Panics

Panics if there is no matching begin_node call.

pub fn label(&mut self, label: impl Into<String>)

Add a label for the current node. By default, a node has no label.

Panics

This method should be called between a call to begin_node and a call to end_node. Panics otherwise.

Trait Implementations

impl Debug for Tree

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

Formats the value using the given formatter.

impl Drop for Tree

fn drop(&mut self)

Executes the destructor for this type.