Struct text_trees::TreeNode

pub struct TreeNode<T> where
    T: Display,  { /* fields omitted */ }

Denotes a node in the tree, and any node can be the root of a tree when output. The generic parameter T must implement Display which is used to generate the label for each node in the output.

Note that From<T> is implemented allowing a nice short-cut for node creation, and From<&T> is also implemented for types that also implement Clone.

Implementations

impl<T> TreeNode<T> where
    T: Display, 

pub fn new(data: T) -> Self

Construct a new tree node with the provided data value.

pub fn with_children(data: T, children: impl Iterator<Item = T>) -> Self where
    T: Sized, 

Construct a new tree node with the provided data value and an iterator that provides child data items.

pub fn with_child_nodes(
    data: T,
    children: impl Iterator<Item = TreeNode<T>>
) -> Self where
    T: Sized, 

Construct a new tree node with the provided data value and an iterator that provides pre-constructed TreeNode values as child nodes.

pub fn data(&self) -> &T

Return a reference to the data item for this node.

pub fn label(&self) -> String

Return the label for this node.

pub fn has_children(&self) -> bool

Returns true if this node has child nodes, else false.

pub fn children(&self) -> impl Iterator<Item = &TreeNode<T>>

Returns an iterator that will return all the child nodes.

pub fn push(&mut self, data: T)

Push a new data item into the list of children.

pub fn push_node(&mut self, child: TreeNode<T>)

Push a new pre-constructed TreeNode into the list of children.

pub fn extend<V>(&mut self, children: impl Iterator<Item = T>)

Extend the list of children with each data item from the provided iterator.

pub fn to_string_with_format(&self, format: &TreeFormatting) -> Result<String>

Return a string containing the generated tree text formatted according to the provided format settings.

Note: in effect Display::fmt calls this method with default formatting.

pub fn write(&self, to_writer: &mut impl Write) -> Result<()> where
    T: Display, 

Write this tree to the provided implementation of std::io::Write with default formatting.

pub fn write_with_format(
    &self,
    to_writer: &mut impl Write,
    format: &TreeFormatting
) -> Result<()> where
    T: Display, 

Write this tree to the provided implementation of std::io::Write with the provided format settings.

Trait Implementations

impl<T: Clone> Clone for TreeNode<T> where
    T: Display, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for TreeNode<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T> Display for TreeNode<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T, '_> From<&'_ T> for TreeNode<T> where
    T: Display + Clone, 

fn from(v: &T) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for TreeNode<String>

fn from(v: &str) -> Self

Performs the conversion.

impl<T> From<T> for TreeNode<T> where
    T: Display, 

fn from(v: T) -> Self

Performs the conversion.

impl<T> PartialEq<TreeNode<T>> for TreeNode<T> where
    T: Display + PartialEq, 

fn eq(&self, other: &Self) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.