Struct parallel_disk_usage::visualizer::Visualizer

pub struct Visualizer<'a, Name, Data>where
    Name: Display,
    Data: Size,{
    pub data_tree: &'a DataTree<Name, Data>,
    pub bytes_format: Data::DisplayFormat,
    pub direction: Direction,
    pub bar_alignment: BarAlignment,
    pub column_width_distribution: ColumnWidthDistribution,
    pub max_depth: NonZeroUsize,
}

Visualize a DataTree.

The fields of the struct are the construction parameters of the ASCII chart. The Display trait can be used to create the ASCII chart.

Example:

let data_tree: DataTree<OsStringDisplay, Bytes> = create_data_tree();
let visualizer = Visualizer {
    data_tree: &data_tree,
    bytes_format: BytesFormat::MetricUnits,
    direction: Direction::BottomUp,
    bar_alignment: BarAlignment::Right,
    column_width_distribution: ColumnWidthDistribution::total(100),
    max_depth: std::num::NonZeroUsize::new(10).unwrap(),
};
println!("{}", visualizer);

Fields

data_tree: &'a DataTree<Name, Data>

The tree to visualize.

bytes_format: Data::DisplayFormat

Format to be used to display the data.

direction: Direction

The direction of the visualization of the tree.

bar_alignment: BarAlignment

The alignment of the bars.

column_width_distribution: ColumnWidthDistribution

Distribution and total number of characters/blocks can be placed in a line.

max_depth: NonZeroUsize

Maximum number of levels that should be visualized.

Implementations

impl<'a, Name, Data> Visualizer<'a, Name, Data>where Name: Display, Data: Size + Into<u64>,

pub fn rows(self) -> Vec<String>

Create ASCII rows that visualize of the tree, such rows are meant to be printed to a terminal screen.

Trait Implementations

impl<'a, Name, Data> Clone for Visualizer<'a, Name, Data>where Name: Display, Data: Size,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Name, Data> Debug for Visualizer<'a, Name, Data>where Name: Display + Debug, Data: Size + Debug, Data::DisplayFormat: Debug,

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

Formats the value using the given formatter.

impl<'a, Name, Data> Display for Visualizer<'a, Name, Data>where Name: Display, Data: Size + Into<u64>,

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

Create the ASCII chart.

impl<'a, Name, Data> Copy for Visualizer<'a, Name, Data>where Name: Display, Data: Size,