Struct patmatch::Pattern

pub struct Pattern { /* fields omitted */ }

A pattern to match strings against.

Implementations

impl Pattern

pub fn compile(pat: &str, opts: MatchOptions) -> Pattern

Compiles a pattern from a string, using shell-like syntax. If you want to compile your own custom string format, see Pattern::from_iter.

Each of these can be toggled using MatchOptions.

• All characters prefixed with a backslash (\) are interpreted literally.
• (MatchOptions::WILDCARDS) Asterisks (*s) are interpreted as wildcards: e.g. a*b is interpreted as a, a wildcard then b.
• (MatchOptions::UNKNOWN_CHARS) Question marks (?s) are interpreted as optional characters.

pub fn compile_iter<T: IntoIterator<Item = char>>(
    pat: T,
    opts: MatchOptions
) -> Pattern

The same as Pattern::compile, but with an iterator instead of a &str.

pub fn matches(&self, string: &str) -> bool

Checks if string matches the pattern. The pattern is checked for a match “perfectly”, i.e. if it is possible to match by choosing all of the matches optimally, it will do so. This optimizes matching checks if not all features are used.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pattern

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromIterator<Chunk> for Pattern

fn from_iter<T: IntoIterator<Item = Chunk>>(iter: T) -> Self

Used to compile a Pattern from an iterator of Chunks. Note that this allocates memory to store all the Chunks.

Example usage:

use patmatch::{Pattern, Chunk};
let chunk_vec = vec![Chunk::str("IMG_"), Chunk::Wildcard, Chunk::str(".png")];
let pat: Pattern = chunk_vec.into_iter().collect();
assert!(pat.matches("IMG_20170301.png"));
assert!(!pat.matches("stuff.png")); assert!(!pat.matches("IMG_20170302.jpeg"));