Struct AsTree

pub struct AsTree<'a, T: DisplayTree> { /* private fields */ }

A helper struct for formatting a type that implements DisplayTree.

AsTree stores a reference to the type to format. It implements std::fmt::Display, so it can be used in println!, format!, etc…

Styling

AsTree controls the way a tree is styled when it is formatted. The style can be customized using builder methods. See Style for the different aspects that can be customized.

Note: StyleBuilder must be in scope to use the builder methods.

Note: Some styling options use ANSI escape codes and therefore will only work where they are supported. See TextStyle for more information.

Examples

use display_tree::{AsTree, DisplayTree};

#[derive(DisplayTree)]
struct Tree {
    a: i32,
    b: i32,
}

let tree = Tree { a: 1, b: 2 };

assert_eq!(
    format!("{}", AsTree::new(&tree)),
    "Tree\n\
     ├── 1\n\
     └── 2"
);

Specifying a style:

use display_tree::{AsTree, CharSet, DisplayTree, StyleBuilder};

#[derive(DisplayTree)]
struct Tree {
    a: i32,
    b: i32,
}

let tree = Tree { a: 1, b: 2 };

assert_eq!(
    format!("{}", AsTree::new(&tree).char_set(CharSet::DOUBLE_LINE)),
    "Tree\n\
     ╠══ 1\n\
     ╚══ 2"
);

Implementations

impl<'a, T: DisplayTree> AsTree<'a, T>

pub fn new(tree: &'a T) -> Self

Creates a wrapper around a type that implements DisplayTree, allowing it to be formatted.

Examples

use display_tree::{AsTree, DisplayTree};

#[derive(DisplayTree)]
struct Tree;

let as_tree = AsTree::new(&Tree);

pub fn with_style(tree: &'a T, style: Style) -> Self

Creates a wrapper around a type that implements DisplayTree, allowing it to be formatted with the given style.

Examples

use display_tree::{AsTree, DisplayTree, Style};

#[derive(DisplayTree)]
struct Tree;

let as_styled_tree = AsTree::with_style(&Tree, Style::default());

Trait Implementations

impl<'a, T: DisplayTree> Display for AsTree<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: DisplayTree> StyleBuilder for AsTree<'a, T>

fn char_set(self, char_set: CharSet) -> Self

Sets the CharSet making up the branches of the tree.

fn indentation(self, indentation: u32) -> Self

Sets the indentation of each node.

fn leaf_style(self, style: TextStyle) -> Self

Sets the style of the leaves of the tree. See TextStyle for more information.

fn branch_style(self, style: TextStyle) -> Self

Sets the style of the branches of the tre. See TextStyle for more information.

fn leaf_color(self, color: Color) -> Self

Sets the color of the leaves of the tree. See Color for more information.

fn leaf_background_color(self, color: Color) -> Self

Sets the background color of the leaves of the tree. See Color for more information.

fn bold_leaves(self) -> Self

Renders the leaves as bold.

fn faint_leaves(self) -> Self

Decreases the intensity of the leaves.

fn italic_leaves(self) -> Self

Italicises the leaves.

fn underlined_leaves(self) -> Self

Underlines the leaves.

fn strikethrough_leaves(self) -> Self

Causes the leaves to be crossed-out.

fn branch_color(self, color: Color) -> Self

Sets the color of the branches of the tree. See Color for more information.

fn branch_background_color(self, color: Color) -> Self

Sets the background color of the branches of the tree. See Color for more information.

fn bold_branches(self) -> Self

Renders the branches as bold.

fn faint_branches(self) -> Self

Decreases the intensity of the branches.