Struct wax::walk::GlobWalker

pub struct GlobWalker { /* private fields */ }

Available on crate feature walk only.

Describes iteration over matching files in a directory tree.

A walker provides the paths walked by a Glob prior to iteration, most notably the root path, which may differ from the directory passed to walking functions. When ready, it can be converted into an iterator over matching files.

See Glob::walker.

Implementations

impl GlobWalker

pub fn root_prefix_paths(&self) -> (&Path, &Path)

Gets the root and prefix paths.

The root path is the path to the walked directory tree. This path may differ from the directory passed to walking functions like Glob::walk, because it may incorporate an invariant path prefix from the glob expression.

The prefix path is the invariant path prefix of the glob expression. This path may be empty and is always a suffix of the root path.

The following table describes some example paths when using Glob::walk.

Glob Expression	Directory	Root	Prefix
**/*.txt	/home/user	/home/user
projects/**/src/**/*.rs	.	./projects	projects
/var/log/**/*.log	.	/var/log	/var/log

See also Entry::root_relative_paths.

pub fn walk(self) -> impl 'static + FileIterator<Entry = GlobEntry>

Converts a walker into an iterator over matching files in its directory tree.

See Glob::walk.

pub fn walk_with_behavior( self, behavior: impl Into<WalkBehavior> ) -> impl 'static + FileIterator<Entry = GlobEntry, Residue = TreeEntry>

Converts a walker into an iterator over matching files in its directory tree.

See Glob::walk_with_behavior.

Trait Implementations

impl Clone for GlobWalker

fn clone(&self) -> GlobWalker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobWalker

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

Formats the value using the given formatter.