Crate pathpatterns

Include/Exclude file pattern matching.

This implements a glob Pattern similar to git’s matching done in include/exclude files, and some helper methods to figure out whether a file should be included given its designated path and a list of include/exclude patterns.

Here’s a rather long matching example:

let file_list: &'static [&'static [u8]] = &[
    b"/things",
    b"/things/file1.dat",
    b"/things/file2.dat",
    b"/things/shop",
    b"/things/shop/info.txt",
    b"/things/shop/apples",
    b"/things/shop/apples/gala.txt",
    b"/things/shop/apples/golden-delicious.txt",
    b"/things/shop/bananas",
    b"/things/shop/bananas/straight.txt",
    b"/things/shop/bananas/curved.txt",
    b"/things/shop/bananas/curved.bak",
    b"/things/shop/bananas/other.txt",
];

let mut list = vec![
    MatchEntry::include(Pattern::path("shop")?),
    MatchEntry::exclude(Pattern::path("bananas")?),
    MatchEntry::include(Pattern::path("bananas/curved.*")?),
];

assert_eq!(list.matches("/things", None), None);
assert_eq!(list.matches("/things/shop", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/bananas", None), Some(MatchType::Exclude));
assert_eq!(list.matches("/things/shop/bananas/curved.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/bananas/curved.bak", None), Some(MatchType::Include));

// this will exclude the curved.bak file
list.push(MatchEntry::exclude(Pattern::path("curved.bak")?));
assert_eq!(list.matches("/things/shop/bananas/curved.bak", None), Some(MatchType::Exclude));
list.pop();

// but this will not:
list.push(
    MatchEntry::new(Pattern::path("curved.bak")?, MatchType::Exclude)
        .flags(MatchFlag::ANCHORED)
);
// or: list.push
assert_eq!(list.matches("/things/shop/bananas/curved.bak", None), Some(MatchType::Include));
list.pop();

// let's check some patterns, anything starting with a 'c', 'f' or 's':
let mut list = vec![MatchEntry::include(Pattern::path("[cfs]*")?)];
assert_eq!(list.matches("/things", None), None);
assert_eq!(list.matches("/things/file1.dat", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/file2.dat", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/info.txt", None), None);
assert_eq!(list.matches("/things/shop/apples", None), None);
assert_eq!(list.matches("/things/shop/apples/gala.txt", None), None);
assert_eq!(list.matches("/things/shop/apples/golden-delicious.txt", None), None);
assert_eq!(list.matches("/things/shop/bananas", None), None);
assert_eq!(list.matches("/things/shop/bananas/straight.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/bananas/curved.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/shop/bananas/curved.bak", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/bananas/other.txt", None), None);

// If we add `**` we end up including the entire `shop/` subtree:
list.push(MatchEntry::include(Pattern::path("[cfs]*/**")?));
assert_eq!(list.matches("/things", None), None);
assert_eq!(list.matches("/things/file1.dat", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/file2.dat", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/info.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/apples", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/apples/gala.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/shop/apples/golden-delicious.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/bananas", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/bananas/straight.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/things/shop/bananas/curved.txt", None), Some(MatchType::Include));
assert_eq!(list.matches("/shop/bananas/curved.bak", None), Some(MatchType::Include));
assert_eq!(list.matches("/shop/bananas/other.txt", None), Some(MatchType::Include));

Structs

MatchEntry

A single entry in a MatchList.

MatchFlag

These flags influence what kind of paths should be matched.

Pattern

An fnmatch-like pattern working like in git, with support for * vs ** distinction for paths.

PatternFlag

Flags affecting how a pattern should match.

Enums

MatchPattern

A pattern entry. For now this only contains glob patterns, but we may want to add regex patterns or user defined callback functions later on as well.

MatchType

A pattern can be used as an include or an exclude pattern. In a list of MatchEntrys, later patterns take precedence over earlier patterns and the order of includes vs excludes makes a difference.

ParseError

Error cases which may happen while parsing a pattern.

Traits

MatchList

This provides matches and matches_exact methods to lists of MatchEntrys.