Struct Style

pub struct Style {
    pub char_set: CharSet,
    pub indentation: u32,
    pub leaf_style: TextStyle,
    pub branch_style: TextStyle,
}

A type that describes the way a type that implements DisplayTree should be formatted.

Prefer using builder methods, either on Style or AsTree, over constructing an instance of Style manually.

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

Examples

use display_tree::{CharSet, Color, Style, StyleBuilder};

let style = Style::default()
    .leaf_color(Color::Blue)
    .branch_background_color(Color::Red)
    .indentation(4)
    .char_set(CharSet::SINGLE_LINE_CURVED);

Fields

char_set: CharSet

The CharSet making up the branches of the tree.

indentation: u32

The indentation of each node.

leaf_style: TextStyle

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

branch_style: TextStyle

The style of the branches of the tree. See TextStyle for more information.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Style

fn default() -> Self

The default Style used if none is specified.

Default values:

• char_set: CharSet::SINGLE_LINE
• indentation: 2
• leaf_style: TextStyle::default()
• branch_style: TextStyle::default()

impl StyleBuilder for Style

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.

impl Copy for Style