Struct ScanConfig 

pub struct ScanConfig {
    pub root: PathBuf,
    pub follow_symlinks: bool,
    pub cross_filesystems: bool,
    pub apparent_size: bool,
    pub count_hard_links: bool,
    pub max_depth: Option<u32>,
    pub max_entries: Option<u64>,
    pub ignore_patterns: Vec<String>,
    pub threads: usize,
    pub include_hidden: bool,
    pub git_status: bool,
    /* private fields */
}

Configuration for scanning operations.

Fields

root: PathBuf

Root path to scan.

follow_symlinks: bool

Follow symbolic links.

cross_filesystems: bool

Cross filesystem boundaries.

apparent_size: bool

Use apparent size vs disk usage.

count_hard_links: bool

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

max_depth: Option<u32>

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.

max_entries: Option<u64>

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.

ignore_patterns: Vec<String>

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

threads: usize

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

include_hidden: bool

Include hidden files (starting with .).

git_status: bool

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

Implementations

impl ScanConfig

pub fn builder() -> ScanConfigBuilder

Create a new scan config builder.

pub fn new(root: impl Into<PathBuf>) -> ScanConfig

Create a simple config for scanning a path.

pub fn validate(&self) -> Result<(), String>

Validate a directly constructed or deserialized configuration before use.

pub fn build_ignore_globset( patterns: &[String], ) -> Result<Option<GlobSet>, String>

Compile every supplied pattern, rejecting invalid patterns as a unit.

pub fn effective_ignore_globset(&self) -> Result<Option<GlobSet>, String>

Return a compiled snapshot of the current patterns, never a stale cache.

pub fn compile_patterns(&mut self) -> Result<(), String>

Cache the current valid patterns. Public-field mutations are detected automatically; callers need not manually invalidate this cache.

pub fn should_ignore(&self, name: &str) -> Result<bool, String>

Match a name, returning an error if any configured pattern is invalid.

pub fn should_skip_hidden(&self, name: &str) -> bool

Check if hidden files should be skipped.

Trait Implementations

impl Clone for ScanConfig

fn clone(&self) -> ScanConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanConfig

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

Formats the value using the given formatter.

impl Default for ScanConfig

fn default() -> ScanConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScanConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScanConfig

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.