Struct Gitignore

pub struct Gitignore<P: AsRef<Path>> {
    pub root: P,
    /* private fields */
}

Used to match globs against user-provided paths.

Fields

root: P

Current working directory if created with Gitignore::default().

Implementations

impl<P: AsRef<Path>> Gitignore<P>

pub fn new( root: P, require_literal_separator: bool, case_insensitive: bool, ) -> Gitignore<P>

Creates a new instance. Requires a path that serves as a root for all path calculations and matching options as defined in the glob crate.

Examples

let cwd = env::current_dir().unwrap();
let ig = Gitignore::new(cwd, true, true);

pub fn ignores(&mut self, lines: &[&str], target: impl AsRef<Path>) -> bool

Checks if the target is ignored by provided list of gitignore patterns.

Examples

let globs = vec!["lib/*.js", "!lib/include.js"];
assert!(!ig.ignores(&globs, ig.root.join("lib/include.js")));

Trait Implementations

impl Default for Gitignore<PathBuf>

fn default() -> Self

Creates a new instance using current working directory.