Struct text_trees::FormatCharacters

pub struct FormatCharacters {
    pub down_facing_angle: char,
    pub down_facing_tee: char,
    pub vertical_line: char,
    pub horizontal_line: char,
    pub horizontal_space: char,
    pub horizontal_line_count: usize,
    pub right_facing_tee: char,
    pub right_facing_angle: char,
    pub label_space_char: char,
    pub label_space_count: usize,
}

Contains the set of characters, and counts, to use when line formatting.

Fields

down_facing_angle: char

This character is used to connect the root of the tree when line anchors are on the left. ASCII value '+', box character value '┌'.

down_facing_tee: char

This character is used to connect non-root parents in the tree when line anchors are on the left. ASCII value ',', box character value '┬'.

vertical_line: char

This character is used as the vertical connector between parent and child nodes. ASCII value '|', box character value '│'.

horizontal_line: char

This character is used as the horizontal connector to node labels. ASCII value '-', box character value '─'.

horizontal_space: char

The character to use instead of horizontal_line where lines are not present. ASCII value ' ', box character value ' '.

horizontal_line_count: usize

The number of horizontal_line, or horizontal_space characters connecting lines to labels.

right_facing_tee: char

This character is used to connect non-terminal child nodes. ASCII value '+', box character value '├'.

right_facing_angle: char

This character is used to connect terminal child nodes. ASCII value '\'', box character value '└'.

label_space_char: char

This character is used as the spacing between the lines of the tree and the labels of each node. ASCII value ' ', box character value ' '.

label_space_count: usize

The number of label_space_char characters between the lines of the tree and the labels of each node. ASCII value '', box character value ''.

Implementations

impl FormatCharacters

pub fn ascii() -> Self

The set of commonly used ASCII characters used for tree formatting.

pub fn box_chars() -> Self

The set of commonly used line drawing characters used for tree formatting.

Trait Implementations

impl Clone for FormatCharacters

fn clone(&self) -> FormatCharacters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FormatCharacters

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

Formats the value using the given formatter.

impl Default for FormatCharacters

fn default() -> Self

Returns the "default value" for a type.