Struct ignore::gitignore::GitignoreBuilder
source · pub struct GitignoreBuilder { /* private fields */ }
Expand description
Builds a matcher for a single set of globs from a .gitignore file.
Implementations§
source§impl GitignoreBuilder
impl GitignoreBuilder
sourcepub fn new<P: AsRef<Path>>(root: P) -> GitignoreBuilder
pub fn new<P: AsRef<Path>>(root: P) -> GitignoreBuilder
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.
sourcepub fn build(&self) -> Result<Gitignore, Error>
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.
sourcepub fn build_global(self) -> (Gitignore, Option<Error>)
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.
sourcepub fn add<P: AsRef<Path>>(&mut self, path: P) -> Option<Error>
pub fn add<P: AsRef<Path>>(&mut self, path: P) -> Option<Error>
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.
sourcepub fn add_line(
&mut self,
from: Option<PathBuf>,
line: &str
) -> Result<&mut GitignoreBuilder, Error>
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.
sourcepub fn case_insensitive(
&mut self,
yes: bool
) -> Result<&mut GitignoreBuilder, Error>
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.
Trait Implementations§
source§impl Clone for GitignoreBuilder
impl Clone for GitignoreBuilder
source§fn clone(&self) -> GitignoreBuilder
fn clone(&self) -> GitignoreBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more