Struct DataTree

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

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, Size: Size> DataTree<Name, Size>

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

Create reflection.

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

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

Create a tree representation of a directory.

pub fn file(name: Name, size: Size) -> Self

Create a tree representation of a file.

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

where Size: Copy,

Create a directory constructor of fixed inode size.

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

pub fn name(&self) -> &Name

Extract name

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

Get mutable reference to name.

pub fn size(&self) -> Size

Extract total disk usage

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

Extract children

impl<Name, Size> DataTree<Name, Size>

where Self: Send, Size: 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 Size: Into<u64>,

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

impl<Name, Size> DataTree<Name, Size>

where Self: Send, Size: 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, Size: Debug + Size> Debug for DataTree<Name, Size>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<Size, SizeGetter, Report> From<FsTreeBuilder<Size, SizeGetter, Report>> for DataTree<OsStringDisplay, Size>

where Report: Reporter<Size> + Sync, Size: Size + Send + Sync, SizeGetter: GetSize<Size = Size> + Sync,

fn from(builder: FsTreeBuilder<Size, SizeGetter, Report>) -> Self

Create a DataTree from an FsTreeBuilder.

impl<Path, Name, Size, GetInfo, JoinPath> From<TreeBuilder<Path, Name, Size, GetInfo, JoinPath>> for DataTree<Name, Size>

where Path: Send + Sync, Name: Send + Sync, GetInfo: Fn(&Path) -> Info<Name, Size> + Copy + Send + Sync, JoinPath: Fn(&Path, &Name) -> Path + Copy + Send + Sync, Size: Size + Send,

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

Create a DataTree from a TreeBuilder.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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