Struct text_trees::TreeFormatting

pub struct TreeFormatting {
    pub prefix_str: Option<String>,
    pub orientation: TreeOrientation,
    pub anchor: AnchorPosition,
    pub chars: FormatCharacters,
}

This structure collects together all the formatting options that control how the tree is output.

Fields

prefix_str: Option<String>

A prefix string written before every line. While no validation is performed on this value, if newline (or other formatting) characters are included the tree is likely to appear disjointed.

orientation: TreeOrientation

The orientation to write the tree.

anchor: AnchorPosition

The line anchor position.

chars: FormatCharacters

The set of characters to use when line formatting.

Implementations

impl TreeFormatting

pub fn dir_tree(chars: FormatCharacters) -> Self

Construct the common options for a directory tree using the provided format characters.

pub fn dir_tree_with_prefix(chars: FormatCharacters, prefix_str: String) -> Self

Construct the common options for a directory tree using the provided format characters. Additionally, the value for prefix_str will be used for each output line.

pub fn dir_tree_left(chars: FormatCharacters) -> Self

Construct the common options for a directory tree, with lines anchored to the left, using the provided format characters.

pub fn dir_tree_left_with_prefix(
    chars: FormatCharacters,
    prefix_str: String
) -> Self

Construct the common options for a directory tree, with lines anchored to the left, using the provided format characters. Additionally, the value for prefix_str will be used for each output line.

Trait Implementations

impl Clone for TreeFormatting

fn clone(&self) -> TreeFormatting

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeFormatting

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

Formats the value using the given formatter.

impl Default for TreeFormatting

fn default() -> Self

Returns the "default value" for a type.