Struct globset::GlobBuilder

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

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.

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.

Trait Implementations

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

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

Returns a copy of the value.

pub 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.