ferralk 1.0.0

Glob matching and parallel filesystem walking, byte-first, with an unsafe-free matcher.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! Walks several roots and keeps going past everything that cannot be read,
//! then reports it: a missing root, a directory without permission, an
//! unreadable ignore file.
//!
//! ```sh
//! cargo run -p ferralk --example keep_going -- <root>...
//! cargo run -p ferralk --example keep_going -- crates does-not-exist
//! ```

use std::{env, error::Error, io, path::PathBuf};

use ferralk::{WalkOperation, Walker};

fn main() -> Result<(), Box<dyn Error>> {
    let mut roots = env::args_os().skip(1).map(PathBuf::from);
    let first = roots.next().unwrap_or_else(|| PathBuf::from("."));
    let walker = Walker::new(first)
        .add_roots(roots)?
        .respect_git_ignore(true);

    // The default `ErrorPolicy::Collect`: every recoverable error is kept next
    // to the entries, and one failing root does not discard the others.
    let result = walker.collect()?;
    println!("{} entries", result.entries().len());

    for error in result.errors() {
        let kind = error
            .source()
            .and_then(|cause| cause.downcast_ref::<io::Error>())
            .map(io::Error::kind);
        // Decide from the typed parts; the message text is for people.
        let advice = match (error.operation(), kind) {
            (WalkOperation::ReadDir, Some(io::ErrorKind::NotFound)) => "does not exist",
            (WalkOperation::ReadDir, Some(io::ErrorKind::PermissionDenied)) => "not permitted",
            (WalkOperation::ReadIgnore, _) => "ignore rules skipped",
            _ => "not walked",
        };
        let cause = error.source().map(ToString::to_string).unwrap_or_default();
        eprintln!("{}: {advice} ({error}: {cause})", error.path().display());
    }

    if result.errors().is_empty() {
        Ok(())
    } else {
        Err(format!("{} error(s)", result.errors().len()).into())
    }
}