Struct WalkConfiguration 

#[non_exhaustive]
pub struct WalkConfiguration<'p> { /* private fields */ }

Options controlling recursive traversal with walk.

Implementations

impl<'p> WalkConfiguration<'p>

pub fn noxdev(self) -> Self

Enable configuration to not traverse mount points.

Note that the mount point directory itself will still be visited (passed to the callback); only traversal into it is prevented. To skip mount point directories entirely, use skip_mountpoints.

pub fn skip_mountpoints(self) -> Self

Skip mount point directories entirely during the walk.

When enabled, directories that are mount points will not be visited (the callback will not be invoked for them) and will not be traversed.

This is independent from noxdev – skip_mountpoints controls whether mount point directories are visited at all, while noxdev controls whether the walk traverses into directories on different devices. In practice you may want to use both together.

This option currently only has an effect on Linux.

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

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

Set a function for sorting directory entries.

pub fn sort_by_file_name(self) -> Self

Sort directory entries by file name.

pub fn path_base(self, base: &'p Path) -> Self

Change the inital state for the path. By default the computed path is relative. This has no effect on the filesystem traversal - it solely affects the value of WalkComponent::path.

Trait Implementations

impl Debug for WalkConfiguration<'_>

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

Formats the value using the given formatter.

impl<'p> Default for WalkConfiguration<'p>

fn default() -> WalkConfiguration<'p>

Returns the “default value” for a type.