Struct GlobBuilder

pub struct GlobBuilder<'a> { /* private fields */ }

A builder for a pattern.

This builder enables configuring the match semantics of a pattern. For example, one can make matching case insensitive.

The lifetime 'a refers to the lifetime of the pattern string.

Implementations

impl<'a> GlobBuilder<'a>

pub fn new(glob: &'a str) -> GlobBuilder<'a>

Create a new builder for the pattern given.

The pattern is not compiled until build is called.

pub fn build(&self) -> Result<Glob, Error>

Parses and builds the pattern.

pub fn case_insensitive(&mut self, yes: bool) -> &mut GlobBuilder<'a>

Toggle whether the pattern matches case insensitively or not.

This is disabled by default.

pub fn literal_separator(&mut self, yes: bool) -> &mut GlobBuilder<'a>

Toggle whether a literal / is required to match a path separator.

By default this is false: * and ? will match /.

pub fn backslash_escape(&mut self, yes: bool) -> &mut GlobBuilder<'a>

When enabled, a back slash (\) may be used to escape special characters in a glob pattern. Additionally, this will prevent \ from being interpreted as a path separator on all platforms.

This is enabled by default on platforms where \ is not a path separator and disabled by default on platforms where \ is a path separator.

pub fn empty_alternates(&mut self, yes: bool) -> &mut GlobBuilder<'a>

Toggle whether an empty pattern in a list of alternates is accepted.

For example, if this is set then the glob foo{,.txt} will match both foo and foo.txt.

By default this is false.

pub fn allow_unclosed_class(&mut self, yes: bool) -> &mut GlobBuilder<'a>

Toggle whether unclosed character classes are allowed. When allowed, a [ without a matching ] is treated literally instead of resulting in a parse error.

For example, if this is set then the glob [abc will be treated as the literal string [abc instead of returning an error.

By default, this is false. Generally speaking, enabling this leads to worse failure modes since the glob parser becomes more permissive. You might want to enable this when compatibility (e.g., with POSIX glob implementations) is more important than good error messages.

Trait Implementations

impl<'a> Clone for GlobBuilder<'a>

fn clone(&self) -> GlobBuilder<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GlobBuilder<'a>

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

Formats the value using the given formatter.