Struct GitignoreBuilder

pub struct GitignoreBuilder { /* private fields */ }

Builds a matcher for a single set of globs from a .gitignore file.

Implementations

impl GitignoreBuilder

pub fn new<P>(root: P) -> GitignoreBuilder

where P: AsRef<Path>,

Create a new builder for a gitignore file.

The path given should be the path at which the globs for this gitignore file should be matched. Note that paths are always matched relative to the root path given here. Generally, the root path should correspond to the directory containing a .gitignore file.

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

Builds a new matcher from the globs added so far.

Once a matcher is built, no new globs can be added to it.

pub fn build_global(self) -> (Gitignore, Option<Error>)

Build a global gitignore matcher using the configuration in this builder.

This consumes ownership of the builder unlike build because it must mutate the builder to add the global gitignore globs.

Note that this ignores the path given to this builder’s constructor and instead derives the path automatically from git’s global configuration.

pub fn add<P>(&mut self, path: P) -> Option<Error>

where P: AsRef<Path>,

Add each glob from the file path given.

The file given should be formatted as a gitignore file.

Note that partial errors can be returned. For example, if there was a problem adding one glob, an error for that will be returned, but all other valid globs will still be added.

pub fn add_line( &mut self, from: Option<PathBuf>, line: &str, ) -> Result<&mut GitignoreBuilder, Error>

Add a line from a gitignore file to this builder.

If this line came from a particular gitignore file, then its path should be provided here.

If the line could not be parsed as a glob, then an error is returned.

pub fn case_insensitive( &mut self, yes: bool, ) -> Result<&mut GitignoreBuilder, Error>

Toggle whether the globs should be matched case insensitively or not.

When this option is changed, only globs added after the change will be affected.

This is disabled by default.

pub fn allow_unclosed_class(&mut self, yes: bool) -> &mut GitignoreBuilder

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 true in order to match established gitignore semantics. 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 Clone for GitignoreBuilder

fn clone(&self) -> GitignoreBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitignoreBuilder

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

Formats the value using the given formatter.