Struct Matcher 

pub struct Matcher<'a, P>
where
    P: AsRef<Path>,
{ /* private fields */ }

Matcher type for transformation into an iterator.

This type exists such that Builder::build can return a result type (whereas into_iter cannot). Notice that iter() is not implemented due to the use of references.

Implementations

impl<'a, P> Matcher<'a, P>

where P: AsRef<Path>,

pub fn glob(&self) -> &str

Provides the original glob-pattern used to create this Matcher.

This is the unchanged glob, i.e., no relative path components have been resolved.

pub fn root(&self) -> String

Provides the resolved root folder used by the Matcher.

This directory already contains the path components from the original glob. The main intention of this function is to for debugging or logging (thus a String).

pub fn rest(&self) -> &str

Provides the resolved glob used by the Matcher.

All relative path components have been resolved for this glob. The glob is of type &str since all globs are input parameters and specified as strings (and not paths).

pub fn is_match(&self, p: P) -> bool

Checks whether the provided path is a match for the stored glob.

Trait Implementations

impl<'a, P> Debug for Matcher<'a, P>

where P: AsRef<Path> + Debug,

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

Formats the value using the given formatter.

impl<'a, P> IntoIterator for Matcher<'a, P>

where P: AsRef<Path>,

fn into_iter(self) -> Self::IntoIter

Transform the Matcher into a recursive directory iterator.

type Item = Result<PathBuf, Error>

The type of the elements being iterated over.

type IntoIter = IterAll<P>

Which kind of iterator are we turning this into?