Struct Gitignore

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

Used to match globs against user-provided paths.

Fields§

§root: P

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

Implementations§

Source§

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

Source

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);
Source

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§

Source§

impl Default for Gitignore<PathBuf>

Source§

fn default() -> Self

Creates a new instance using current working directory.

Auto Trait Implementations§

§

impl<P> Freeze for Gitignore<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for Gitignore<P>
where P: RefUnwindSafe,

§

impl<P> Send for Gitignore<P>
where P: Send,

§

impl<P> Sync for Gitignore<P>
where P: Sync,

§

impl<P> Unpin for Gitignore<P>
where P: Unpin,

§

impl<P> UnwindSafe for Gitignore<P>
where P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.