Struct parallel_disk_usage::data_tree::DataTree

pub struct DataTree<Name, Data: Size> { /* fields omitted */ }

Disk usage data of a filesystem tree.

Construction: There are 3 main ways to create a DataTree:

• Use FsTreeBuilder to create it from the real filesystem.
• Use TreeBuilder to create it from a representation of a filesystem.
• Use Reflection.

Visualization: Use the Visualizer struct to create an ASCII chart that visualizes DataTree.

Serialization and deserialization: (feature: json) DataTree does not implement Serialize and Deserialize traits directly, instead, it can be converted into/from a Reflection which implements these traits.

Implementations

impl<Name, Data: Size> DataTree<Name, Data>

pub fn into_reflection(self) -> Reflection<Name, Data>

Create reflection.

impl<Name, Data: Size> DataTree<Name, Data>

pub fn dir(name: Name, inode_size: Data, children: Vec<Self>) -> Self

Create a tree representation of a directory.

pub fn file(name: Name, data: Data) -> Self

Create a tree representation of a file.

pub fn fixed_size_dir_constructor(
    inode_size: Data
) -> impl Fn(Name, Vec<Self>) -> Self where
    Data: Copy, 

Create a directory constructor of fixed inode size.

impl<Name, Data: Size> DataTree<Name, Data>

pub fn name(&self) -> &Name

Extract name

pub fn name_mut(&mut self) -> &mut Name

Get mutable reference to name.

pub fn data(&self) -> Data

Extract total disk usage

pub fn children(&self) -> &Vec<Self>

Extract children

impl<Name, Data> DataTree<Name, Data> where
    Self: Send,
    Data: Size, 

pub fn par_retain(&mut self, predicate: impl Fn(&Self) -> bool + Copy + Sync)

Recursively cull all descendants that do not satisfy given predicate, in parallel.

pub fn into_par_retained(
    self,
    predicate: impl Fn(&Self) -> bool + Copy + Sync
) -> Self

Process the tree via par_retain method.

pub fn par_cull_insignificant_data(&mut self, min_ratio: f32) where
    Data: Into<u64>, 

Recursively cull all descendants whose data are too small relative to root.

impl<Name, Data> DataTree<Name, Data> where
    Self: Send,
    Data: Size, 

pub fn par_sort_by(
    &mut self,
    compare: impl Fn(&Self, &Self) -> Ordering + Copy + Sync
)

Sort all descendants recursively, in parallel.

pub fn into_par_sorted(
    self,
    compare: impl Fn(&Self, &Self) -> Ordering + Copy + Sync
) -> Self

Process the tree via par_sort_by method.

Trait Implementations

impl<Name: Debug, Data: Debug + Size> Debug for DataTree<Name, Data>

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

Formats the value using the given formatter.

impl<Name, Data: Size> From<DataTree<Name, Data>> for Reflection<Name, Data>

fn from(source: DataTree<Name, Data>) -> Self

Performs the conversion.

impl<Data, GetData, Report> From<FsTreeBuilder<Data, GetData, Report>> for DataTree<OsStringDisplay, Data> where
    Data: Size + Send + Sync,
    GetData: Fn(&Metadata) -> Data + Sync,
    Report: Reporter<Data> + Sync, 

fn from(builder: FsTreeBuilder<Data, GetData, Report>) -> Self

Create a DataTree from an FsTreeBuilder.

impl<Path, Name, Data, GetInfo, JoinPath> From<TreeBuilder<Path, Name, Data, GetInfo, JoinPath>> for DataTree<Name, Data> where
    Path: Send + Sync,
    Name: Send + Sync,
    Data: Size + Send,
    GetInfo: Fn(&Path) -> Info<Name, Data> + Copy + Send + Sync,
    JoinPath: Fn(&Path, &Name) -> Path + Copy + Send + Sync, 

fn from(builder: TreeBuilder<Path, Name, Data, GetInfo, JoinPath>) -> Self

Create a DataTree from a TreeBuilder.

impl<Name: PartialEq, Data: PartialEq + Size> PartialEq<DataTree<Name, Data>> for DataTree<Name, Data>

fn eq(&self, other: &DataTree<Name, Data>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DataTree<Name, Data>) -> bool

This method tests for !=.

impl<Name: Eq, Data: Eq + Size> Eq for DataTree<Name, Data>

impl<Name, Data: Size> StructuralEq for DataTree<Name, Data>

impl<Name, Data: Size> StructuralPartialEq for DataTree<Name, Data>