Expand description
The ignore crate provides a fast recursive directory iterator that respects
various filters such as globs, file types and .gitignore
files. The precise
matching rules and precedence is explained in the documentation for
WalkBuilder
.
Secondarily, this crate exposes gitignore and file type matchers for use cases that demand more fine-grained control.
Example
This example shows the most basic usage of this crate. This code will
recursively traverse the current directory while automatically filtering out
files and directories according to ignore globs found in files like
.ignore
and .gitignore
:
use ignore::Walk;
for result in Walk::new("./") {
// Each item yielded by the iterator is either a directory entry or an
// error, so either print the path or the error.
match result {
Ok(entry) => println!("{}", entry.path().display()),
Err(err) => println!("ERROR: {}", err),
}
}
Example: advanced
By default, the recursive directory iterator will ignore hidden files and
directories. This can be disabled by building the iterator with WalkBuilder
:
use ignore::WalkBuilder;
for result in WalkBuilder::new("./").hidden(false).build() {
println!("{:?}", result);
}
See the documentation for WalkBuilder
for many other options.
Modules
--include
or --exclude
in command
line tools.