[−][src]Struct jwalk::WalkDir

Create a builder for a recursive directory iterator starting at the file path root. If root is a directory, then it is the first item yielded by the iterator. If root is a file, then it is the first and only item yielded by the iterator.

Set the maximum depth of entries yield by the iterator.

The smallest depth is 0 and always corresponds to the path given to the new function on this type. Its direct descendents have depth 1, and their descendents have depth 2, and so on.

Note that a depth < 2 will automatically change thread_count to 1. jwalks parrallelism happens at the fs::read_dir level, so it only makes sense to use multiple threads when reading more then one directory.

Sort entries per directory. Use process_entries for custom sorting or filtering.

• 0 Use rayon global pool.
• 1 Perform walk on calling thread.
• n > 1 Construct a new rayon ThreadPool to perform the walk.

Skip hidden entries. Enabled by default.

Preload metadata before yeilding entries. When running in parrallel the metadata is loaded in rayon's thread pool.

Set a function to process (sort/filter/skip) each directory of entries before they are yeilded. Use entry.set_children_spec(None) to yeild that directory but skip descending into its contents.