Struct ScanConfig 

pub struct ScanConfig {
    pub root: PathBuf,
    pub follow_symlinks: bool,
    pub cross_filesystems: bool,
    pub apparent_size: bool,
    pub max_depth: Option<u32>,
    pub ignore_patterns: Vec<String>,
    pub threads: usize,
    pub include_hidden: bool,
    pub compute_hashes: bool,
    pub min_hash_size: u64,
    /* 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.

max_depth: Option<u32>

Maximum depth to traverse (None = unlimited).

ignore_patterns: Vec<String>

Patterns to ignore (gitignore-style glob syntax via globset).

threads: usize

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

include_hidden: bool

Include hidden files (starting with .).

compute_hashes: bool

Compute content hashes during scan.

min_hash_size: u64

Minimum file size to hash (skip tiny files).

Implementations

impl ScanConfig

pub fn builder() -> ScanConfigBuilder

Create a new scan config builder.

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

Create a simple config for scanning a path.

pub fn compile_patterns(&mut self)

Compile ignore patterns into a GlobSet for efficient matching. Call this after modifying ignore_patterns.

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

Check if a name should be ignored based on compiled glob patterns.

pub fn compiled_ignore_set(&self) -> Option<&GlobSet>

Return the compiled GlobSet for ignore patterns, if any.

This is the same set used internally by should_ignore. Useful when callers need an owned, Send + Sync handle (e.g. for closures sent to thread pools) without recompiling the patterns.

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

Formats the value using the given formatter.

impl Default for ScanConfig

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.