Struct globset::Glob

pub struct Glob { /* fields omitted */ }

Glob represents a successfully parsed shell glob pattern.

It cannot be used directly to match file paths, but it can be converted to a regular expression string or a matcher.

Methods

impl Glob

pub fn new(glob: &str) -> Result<Glob, Error>

Builds a new pattern with default options.

pub fn compile_matcher(&self) -> GlobMatcher

Returns a matcher for this pattern.

pub fn glob(&self) -> &str

Returns the original glob pattern used to build this pattern.

pub fn regex(&self) -> &str

Returns the regular expression string for this glob.

Note that regular expressions for globs are intended to be matched on arbitrary bytes (&[u8]) instead of Unicode strings (&str). In particular, globs are frequently used on file paths, where there is no general guarantee that file paths are themselves valid UTF-8. As a result, callers will need to ensure that they are using a regex API that can match on arbitrary bytes. For example, the regex crate's Regex API is not suitable for this since it matches on &str, but its bytes::Regex API is suitable for this.

Trait Implementations

impl Clone for Glob

fn clone(&self) -> Glob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Glob

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

Formats the value using the given formatter.

impl Display for Glob

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

Formats the value using the given formatter.

impl Eq for Glob

impl FromStr for Glob

type Err = Error

The associated error which can be returned from parsing.

fn from_str(glob: &str) -> Result<Self, Self::Err>

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

impl Hash for Glob

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 PartialEq<Glob> for Glob

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for Glob