Struct gitignore::Pattern

pub struct Pattern<'c> {
    pub pattern: Pattern,
    pub anchored: bool,
    pub negation: bool,
    /* private fields */
}

A pattern as found in a .gitignore file.

Fields

pattern: Pattern

The glob pattern after being parsed, negation or trailing directory slashes removed, and the root prepended if anchored.

anchored: bool

Whether the pattern had the root prepended so the matches must be within the root directory. That is to say, whether the pattern was anchored to the root.

negation: bool

Whether the pattern should, if it matches, negate any previously matching patterns. This flag has no effect if no previous patterns had matched.

Implementations

impl<'c> Pattern<'c>

pub fn new(raw_pattern: &str, root: &'c Path) -> Result<Pattern<'c>, Error>

Create a new pattern from the raw glob as found in a .gitignore file.

The value of root must be an absolute path.

pub fn is_excluded(&self, path: &Path, directory: bool) -> bool

Returns true if the given path is matched by the current pattern, and hence would be excluded if found in a .gitignore file. The second argument, directory, is a bool representing whether the given path is a directory - if so, it should be set to true, otherwise false if not (eg. file, special file, symlink).

Note that if the glob was negated (ie. of the format ! some/glob/*.here) then this will return the opposite value, eg. false if the pattern matched, and true if the pattern did not match.

The value of path must be an absolute path.

Trait Implementations

impl<'c> Debug for Pattern<'c>

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

Formats the value using the given formatter.