[−][src]Struct gitignore::Pattern
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>
[src]
pub fn new(raw_pattern: &str, root: &'c Path) -> Result<Pattern<'c>, Error>
[src]
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
[src]
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
Auto Trait Implementations
impl<'c> RefUnwindSafe for Pattern<'c>
impl<'c> Send for Pattern<'c>
impl<'c> Sync for Pattern<'c>
impl<'c> Unpin for Pattern<'c>
impl<'c> UnwindSafe for Pattern<'c>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,