Struct WalkBuilder 

pub struct WalkBuilder { /* private fields */ }

Configures flexible single- or multi-root walking.

Implementations

impl WalkBuilder

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

pub fn add_root(self, root: impl Into<PathBuf>) -> Self

pub const fn options(self, options: WalkOptions) -> Self

pub fn sort_by_file_name(self) -> Self

Sorts each directory by its native file name before descent.

pub fn sort_by<F>(self, compare: F) -> Self

where F: Fn(&DirEntry, &DirEntry) -> Ordering + Send + Sync + 'static,

Sorts each directory with a comparator over complete directory entries.

pub fn sort_by_name<F>(self, compare: F) -> Self

where F: Fn(&OsStr, &OsStr) -> Ordering + Send + Sync + 'static,

Sorts with a native-name comparator without lossy UTF-8 conversion.

pub fn skip_stdout(self, enabled: bool) -> Self

Skips a regular file that refers to redirected standard output.

This prevents feedback loops such as scanning a tree while writing command output into a file inside that same tree.

pub const fn contents_first(self, enabled: bool) -> Self

Emits a directory after all accepted descendants.

pub fn filter_entry<F>(self, filter: F) -> Self

where F: Fn(&WalkEntry) -> bool + Send + Sync + 'static,

Filters entries before emission and prunes rejected directories.

pub fn filter_directories<F>(self, filter: F) -> Self

where F: Fn(&WalkEntry) -> bool + Send + Sync + 'static,

Invokes a directory predicate before descent; files remain accepted.

pub fn filter_directories_stateful<F>(self, filter: F) -> Self

where F: FnMut(&WalkEntry) -> bool + Send + 'static,

Invokes one mutable directory predicate across every configured root.

The callback is serialized behind a mutex so captured state remains coherent if builder internals gain concurrent root traversal later.

pub fn build(self) -> MultiWalker