Struct glob::Pattern

pub struct Pattern { /* fields omitted */ }

A compiled Unix shell style pattern.

• ? matches any single character.

• * matches any (possibly empty) sequence of characters.

• ** matches the current directory and arbitrary subdirectories. This sequence must form a single path component, so both **a and b** are invalid and will result in an error. A sequence of more than two consecutive * characters is also invalid.

• [...] matches any character inside the brackets. Character sequences can also specify ranges of characters, as ordered by Unicode, so e.g. [0-9] specifies any character between 0 and 9 inclusive. An unclosed bracket is invalid.

• [!...] is the negation of [...], i.e. it matches any characters not in the brackets.

• The metacharacters ?, *, [, ] can be matched by using brackets (e.g. [?]). When a ] occurs immediately following [ or [! then it is interpreted as being part of, rather then ending, the character set, so ] and NOT ] can be matched by []] and [!]] respectively. The - character can be specified inside a character sequence pattern by placing it at the start or the end, e.g. [abc-].

Methods

impl Pattern

pub fn new(pattern: &str) -> Result<Self, PatternError>

This function compiles Unix shell style patterns.

An invalid glob pattern will yield a PatternError.

pub fn escape(s: &str) -> String

Escape metacharacters within the given string by surrounding them in brackets. The resulting string will, when compiled into a Pattern, match the input string and nothing else.

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

Return if the given str matches this Pattern using the default match options (i.e. MatchOptions::new()).

Examples

use glob::Pattern;

assert!(Pattern::new("c?t").unwrap().matches("cat"));
assert!(Pattern::new("k[!e]tteh").unwrap().matches("kitteh"));
assert!(Pattern::new("d*g").unwrap().matches("doog"));

pub fn matches_path(&self, path: &Path) -> bool

Return if the given Path, when converted to a str, matches this Pattern using the default match options (i.e. MatchOptions::new()).

pub fn matches_with(&self, str: &str, options: MatchOptions) -> bool

Return if the given str matches this Pattern using the specified match options.

pub fn matches_path_with(&self, path: &Path, options: MatchOptions) -> bool

Return if the given Path, when converted to a str, matches this Pattern using the specified match options.

pub fn as_str(&self) -> &str

Access the original glob pattern.

Trait Implementations

impl PartialOrd<Pattern> for Pattern

fn partial_cmp(&self, other: &Pattern) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Pattern) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Pattern) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Pattern) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Pattern) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<Pattern> for Pattern

fn eq(&self, other: &Pattern) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Pattern) -> bool

This method tests for !=.

impl Default for Pattern

fn default() -> Pattern

Returns the "default value" for a type.

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Pattern

fn cmp(&self, other: &Pattern) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Eq for Pattern

impl Display for Pattern

Show the original glob pattern.

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

Formats the value using the given formatter.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl Hash for Pattern

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for Pattern

type Err = PatternError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, PatternError>

Parses a string s to return a value of this type.