Struct FileTree 

pub struct FileTree {
    pub root: FileNode,
    pub root_path: PathBuf,
    pub scanned_at: SystemTime,
    pub scan_duration: Duration,
    pub config: ScanConfig,
    pub stats: TreeStats,
    pub warnings: Vec<ScanWarning>,
}

Complete scanned file tree with metadata.

Warning: Clone performs a deep clone of the entire tree — O(n) in the number of nodes.

Fields

root: FileNode

Root node of the tree.

root_path: PathBuf

Root path that was scanned.

scanned_at: SystemTime

When this scan was performed.

scan_duration: Duration

Duration of the scan.

config: ScanConfig

Scan configuration used.

stats: TreeStats

Summary statistics.

warnings: Vec<ScanWarning>

Warnings encountered during scan.

Implementations

impl FileTree

pub fn new( root: FileNode, root_path: PathBuf, config: ScanConfig, stats: TreeStats, scan_duration: Duration, warnings: Vec<ScanWarning>, ) -> FileTree

Create a new file tree.

scanned_at is stamped at construction time, which is when the scan finished. scan_duration is supplied by the caller, so the scan’s start time is scanned_at - scan_duration.

pub fn total_size(&self) -> u64

Get the total size of the tree.

pub fn total_files(&self) -> u64

Get the total number of files.

pub fn total_dirs(&self) -> u64

Get the total number of directories.

pub fn has_warnings(&self) -> bool

Check if there were any warnings during scanning.

pub fn warning_count(&self) -> u64

Observed warning count, including explicitly omitted details.

pub fn find(&self, path: &Path) -> Option<&FileNode>

The entry at path, if it is the root or below it.

pub fn remove(&mut self, path: &Path) -> Option<FileNode>

Take the entry at path out of the tree, keeping every ancestor’s size and counts consistent. The root cannot be removed. Call Self::recount after a batch of changes.

pub fn insert(&mut self, parent: &Path, node: FileNode) -> bool

Put node into the directory at parent, replacing any entry with the same name, and keep every ancestor’s size and counts consistent. Returns false, dropping node, if parent is not a directory in the tree. Call Self::recount after a batch of changes.

pub fn recount(&mut self)

Recompute the summary statistics from the tree, after changes.

pub fn remeasure(&mut self, apparent: bool, count_hard_links: bool)

Re-express every size in another measure without rescanning: apparent lengths or allocated blocks, with hard links counted once or each time.

Trait Implementations

impl Clone for FileTree

fn clone(&self) -> FileTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileTree

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileTree

fn deserialize<__D>( __deserializer: __D, ) -> Result<FileTree, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileTree

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.