Struct parallel_disk_usage::visualizer::Visualizer[−][src]

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,
}

Expand description

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

[src]

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

[src]

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

[src]

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

[src]

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

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

[src]

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

Formats the value using the given formatter. Read more

[src]

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

[src]

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

Create the ASCII chart.

[src]

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

Auto Trait Implementations

impl<'a, Name, Data> RefUnwindSafe for Visualizer<'a, Name, Data> where
    Data: RefUnwindSafe,
    Name: RefUnwindSafe,
    <Data as Size>::DisplayFormat: RefUnwindSafe,

impl<'a, Name, Data> Send for Visualizer<'a, Name, Data> where
    Data: Sync,
    Name: Sync,
    <Data as Size>::DisplayFormat: Send,

impl<'a, Name, Data> Sync for Visualizer<'a, Name, Data> where
    Data: Sync,
    Name: Sync,
    <Data as Size>::DisplayFormat: Sync,

impl<'a, Name, Data> Unpin for Visualizer<'a, Name, Data> where
    <Data as Size>::DisplayFormat: Unpin,

impl<'a, Name, Data> UnwindSafe for Visualizer<'a, Name, Data> where
    Data: RefUnwindSafe,
    Name: RefUnwindSafe,
    <Data as Size>::DisplayFormat: UnwindSafe,

Blanket Implementations

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<X> Pipe for X

[src]

fn pipe<Return, Function>(self, f: Function) -> Return where
    Function: FnOnce(Self) -> Return,

Apply f to self. Read more

[src]

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Return where
    Function: FnOnce(&'a Self) -> Return,

Apply f to &self. Read more

[src]

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Return where
    Function: FnOnce(&'a mut Self) -> Return,

Apply f to &mut self. Read more

[src]

fn pipe_as_ref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
    Self: AsRef<Param>,
    Param: 'a + ?Sized,
    Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait AsRef<Param>. Read more

[src]

fn pipe_as_mut<'a, Param, Return, Function>(&'a mut self, f: Function) -> Return where
    Self: AsMut<Param>,
    Param: 'a + ?Sized,
    Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait AsMut<Param>. Read more

[src]

fn pipe_deref<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
    Self: Deref<Target = Param>,
    Param: 'a + ?Sized,
    Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Deref<Param>. Read more

[src]

fn pipe_deref_mut<'a, Param, Return, Function>(
    &'a mut self, 
    f: Function
) -> Return where
    Self: DerefMut<Target = Param>,
    Param: 'a + ?Sized,
    Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait DerefMut<Param>. Read more

[src]

fn pipe_borrow<'a, Param, Return, Function>(&'a self, f: Function) -> Return where
    Self: Borrow<Param>,
    Param: 'a + ?Sized,
    Function: FnOnce(&'a Param) -> Return,

Apply f to &self where f takes a single parameter of type Param and Self implements trait Deref<Param>. Read more

[src]

fn pipe_borrow_mut<'a, Param, Return, Function>(
    &'a mut self, 
    f: Function
) -> Return where
    Self: BorrowMut<Param>,
    Param: 'a + ?Sized,
    Function: FnOnce(&'a mut Param) -> Return,

Apply f to &mut self where f takes a single parameter of type Param and Self implements trait DerefMut<Param>. Read more

[src]

impl<X> Pipe for X

[src]

fn pipe<Return, Function>(self, f: Function) -> Return where
    Function: FnOnce(Self) -> Return,

Apply f to self. Read more

[src]

fn pipe_ref<'a, Return, Function>(&'a self, f: Function) -> Return where
    Function: FnOnce(&'a Self) -> Return,

Apply f to &self. Read more

[src]

fn pipe_mut<'a, Return, Function>(&'a mut self, f: Function) -> Return where
    Function: FnOnce(&'a mut Self) -> Return,

Apply f to &mut self. Read more

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

[src]

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T> ToString for T where
    T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.