Struct bloodhound::ExclusionPattern
[−]
[src]
pub struct ExclusionPattern { /* 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
[src]
fn new(pattern: &str) -> Result<Pattern, PatternError>
[src]
This function compiles Unix shell style patterns.
An invalid glob pattern will yield an error.
fn escape(s: &str) -> String
[src]
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.
fn matches(&self, str: &str) -> bool
[src]
Return if the given str
matches this Pattern
using the default
match options (i.e. MatchOptions::new()
).
Example
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"));
fn matches_path(&self, path: &Path) -> bool
[src]
Return if the given Path
, when converted to a str
, matches this
Pattern
using the default match options (i.e. MatchOptions::new()
).
fn matches_with(&self, str: &str, options: &MatchOptions) -> bool
[src]
Return if the given str
matches this Pattern
using the specified
match options.
fn matches_path_with(&self, path: &Path, options: &MatchOptions) -> bool
[src]
Return if the given Path
, when converted to a str
, matches this
Pattern
using the specified match options.
fn as_str(&'a self) -> &'a str
[src]
Access the original glob pattern.
Trait Implementations
impl Ord for Pattern
[src]
fn cmp(&self, __arg_0: &Pattern) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.22.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.22.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for Pattern
[src]
impl Clone for Pattern
[src]
impl Eq for Pattern
[src]
impl PartialEq<Pattern> for Pattern
[src]
fn eq(&self, __arg_0: &Pattern) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Pattern) -> bool
[src]
This method tests for !=
.
impl FromStr for Pattern
[src]
type Err = PatternError
fn from_str(s: &str) -> Result<Pattern, PatternError>
[src]
impl Debug for Pattern
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter.
impl Display for Pattern
[src]
Show the original glob pattern.
impl Default for Pattern
[src]
impl PartialOrd<Pattern> for Pattern
[src]
fn partial_cmp(&self, __arg_0: &Pattern) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Pattern) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Pattern) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Pattern) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Pattern) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more