Struct git2::Pathspec

pub struct Pathspec { /* fields omitted */ }

Structure representing a compiled pathspec used for matching against various structures.

Implementations

impl Pathspec

pub fn new<I, T>(specs: I) -> Result<Pathspec, Error> where
    T: IntoCString,
    I: IntoIterator<Item = T>, 

Creates a new pathspec from a list of specs to match against.

pub fn match_diff(
    &self,
    diff: &Diff<'_>,
    flags: PathspecFlags
) -> Result<PathspecMatchList<'_>, Error>

Match a pathspec against files in a diff.

The list returned contains the list of all matched filenames (unless you pass PATHSPEC_FAILURES_ONLY in the flags) and may also contain the list of pathspecs with no match if the PATHSPEC_FIND_FAILURES flag is specified.

pub fn match_tree(
    &self,
    tree: &Tree<'_>,
    flags: PathspecFlags
) -> Result<PathspecMatchList<'_>, Error>

Match a pathspec against files in a tree.

The list returned contains the list of all matched filenames (unless you pass PATHSPEC_FAILURES_ONLY in the flags) and may also contain the list of pathspecs with no match if the PATHSPEC_FIND_FAILURES flag is specified.

pub fn match_index(
    &self,
    index: &Index,
    flags: PathspecFlags
) -> Result<PathspecMatchList<'_>, Error>

This matches the pathspec against the files in the repository index.

The list returned contains the list of all matched filenames (unless you pass PATHSPEC_FAILURES_ONLY in the flags) and may also contain the list of pathspecs with no match if the PATHSPEC_FIND_FAILURES flag is specified.

pub fn match_workdir(
    &self,
    repo: &Repository,
    flags: PathspecFlags
) -> Result<PathspecMatchList<'_>, Error>

Match a pathspec against the working directory of a repository.

This matches the pathspec against the current files in the working directory of the repository. It is an error to invoke this on a bare repo. This handles git ignores (i.e. ignored files will not be considered to match the pathspec unless the file is tracked in the index).

The list returned contains the list of all matched filenames (unless you pass PATHSPEC_FAILURES_ONLY in the flags) and may also contain the list of pathspecs with no match if the PATHSPEC_FIND_FAILURES flag is specified.

pub fn matches_path(&self, path: &Path, flags: PathspecFlags) -> bool

Try to match a path against a pathspec

Unlike most of the other pathspec matching functions, this will not fall back on the native case-sensitivity for your platform. You must explicitly pass flags to control case sensitivity or else this will fall back on being case sensitive.

Trait Implementations

impl Drop for Pathspec

fn drop(&mut self)

Executes the destructor for this type.