[−][src]Struct glob::Pattern
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
andb**
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]
pub fn new(pattern: &str) -> Result<Self, PatternError>
[src]
This function compiles Unix shell style patterns.
An invalid glob pattern will yield a PatternError
.
pub 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.
pub fn matches(&self, str: &str) -> bool
[src]
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
[src]
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
[src]
Return if the given str
matches this Pattern
using the specified
match options.
pub 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.
pub fn as_str(&self) -> &str
[src]
Access the original glob pattern.
Trait Implementations
impl PartialOrd<Pattern> for Pattern
[src]
fn partial_cmp(&self, other: &Pattern) -> Option<Ordering>
[src]
fn lt(&self, other: &Pattern) -> bool
[src]
fn le(&self, other: &Pattern) -> bool
[src]
fn gt(&self, other: &Pattern) -> bool
[src]
fn ge(&self, other: &Pattern) -> bool
[src]
impl PartialEq<Pattern> for Pattern
[src]
impl Default for Pattern
[src]
impl Clone for Pattern
[src]
fn clone(&self) -> Pattern
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Ord for Pattern
[src]
fn cmp(&self, other: &Pattern) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Eq for Pattern
[src]
impl Display for Pattern
[src]
Show the original glob pattern.
impl Debug for Pattern
[src]
impl Hash for Pattern
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl FromStr for Pattern
[src]
type Err = PatternError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Self, PatternError>
[src]
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,