Struct TreeBuilder 

pub struct TreeBuilder { /* private fields */ }

A builder for creating tree-structured output.

Implementations

impl TreeBuilder

pub fn new() -> Self

Create a new tree builder.

pub fn with_options(options: DumpOptions) -> Self

Create a new tree builder with options.

pub fn options(&self) -> &DumpOptions

Get the dump options.

pub fn show_keys(&self) -> bool

Check if show_keys is enabled.

pub fn begin_node(&mut self, title: &str)

Add a node with a title (creates a branch point).

pub fn add_leaf(&mut self, title: &str, props: &[(&str, String)])

Add a leaf node with properties.

pub fn add_leaf_with_params( &mut self, title: &str, props: &[(&str, String)], params: Option<&ParameterCollection>, )

Add a leaf node with properties and optional params (for –show-keys debug).

When show_keys option is enabled, dumps all parameters from the collection. Otherwise behaves like add_leaf.

pub fn push(&mut self, has_more_siblings: bool)

Push into a child group (for nesting).

pub fn pop(&mut self)

Pop out of a child group.

pub fn root(&mut self, title: &str)

Add a root node (no prefix).

pub fn finish(self) -> String

Consume and return the built string.

Trait Implementations

impl Default for TreeBuilder

fn default() -> TreeBuilder

Returns the “default value” for a type.