Struct ScanConfigBuilder 

pub struct ScanConfigBuilder { /* private fields */ }

Builder for ScanConfig.

Implementations

impl ScanConfigBuilder

pub fn root<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

Root path to scan.

pub fn follow_symlinks<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Follow symbolic links.

pub fn cross_filesystems<VALUE: Into<bool>>( &mut self, value: VALUE, ) -> &mut Self

Cross filesystem boundaries.

pub fn apparent_size<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Use apparent size vs disk usage.

pub fn count_hard_links<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Count every hard link to a file instead of only the first one seen.

pub fn max_depth<VALUE: Into<Option<u32>>>(&mut self, value: VALUE) -> &mut Self

Deepest level kept in the tree (None = unlimited). Everything below is still traversed and counted into the sizes of the deepest kept directories; only the nodes are not retained.

pub fn max_entries<VALUE: Into<Option<u64>>>( &mut self, value: VALUE, ) -> &mut Self

Maximum descendant entries consumed after hidden/ignore filtering, at every depth (max_depth does not reduce the count). None is unlimited; zero permits only an empty scope. The root does not count. Metadata failures and unsupported file types still count. Exceeding the limit fails the scan instead of returning a partial tree. This is not a bound on walker prefetching, Git enrichment, or total RAM.

pub fn ignore_patterns<VALUE: Into<Vec<String>>>( &mut self, value: VALUE, ) -> &mut Self

Patterns to ignore using globset syntax (not gitignore negation rules).

pub fn threads<VALUE: Into<usize>>(&mut self, value: VALUE) -> &mut Self

Number of threads for scanning (0 = auto-detect).

pub fn include_hidden<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Include hidden files (starting with .).

pub fn git_status<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Annotate nodes with Git status when the root is inside a repository.

pub fn build(&self) -> Result<ScanConfig, ScanConfigBuilderError>

Builds a new ScanConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ScanConfigBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ScanConfigBuilder

fn default() -> Self

Returns the “default value” for a type.