#directory #recursive #walk #iterator #parallel

jwalk

Filesystem walk performed in parallel with streamed and sorted results

5 unstable releases

✓ Uses Rust 2018 edition

new 0.3.0 Feb 21, 2019
0.2.1 Feb 11, 2019
0.2.0 Feb 11, 2019
0.1.1 Feb 9, 2019
0.1.0 Feb 9, 2019

#7 in #recursive

Download history 35/week @ 2019-02-07 1/week @ 2019-02-14

13 downloads per month

MIT license

31KB
803 lines

jwalk

Filesystem walk.

  • Performed in parallel using rayon
  • Entries streamed in sorted order
  • Custom sort/filter/skip

Build Status Latest version

Usage

Add this to your Cargo.toml:

[dependencies]
jwalk = "0.3"

Lean More: docs.rs/jwalk

Example

Recursively iterate over the "foo" directory sorting by name:

use jwalk::{WalkDir};

for entry in WalkDir::new("foo").sort(true) {
  println!("{}", entry?.path().display());
}

Inspiration

This crate is inspired by both walkdir and ignore. It attempts to combine the parallelism of ignore with walkdir's streaming iterator API.

Why use this crate?

This crate is particularly fast when you want streamed sorted results. In my tests its about 4x walkdir speed for sorted results with metadata. Also this crate's process_entries callback allows you to arbitrarily sort/filter/skip entries before they are yielded.

Why not use this crate?

Directory traversal is already pretty fast. If you don't need this crate's speed then walkdir provides a smaller and more tested single threaded implementation.

Benchmarks

Benchmarks comparing this crate with jwalk and ignore.

Dependencies

~1.5MB
~30K SLoC