Skip to main content

Pathspec

Struct Pathspec 

Source
pub struct Pathspec { /* private fields */ }
Expand description

Parsed and optionally work-tree–resolved pathspec list for matching and display.

Implementations§

Source§

impl Pathspec

Source

pub fn scoped( items: impl IntoIterator<Item = impl AsRef<str>>, globals: PathspecGlobalFlags, ) -> Self

Build a scoped pathspec from already-resolved work-tree-relative strings.

Source

pub fn entire_tree(globals: PathspecGlobalFlags) -> Self

Pathspec list that selects the entire work tree (no argv paths).

Source

pub fn parse( items: impl IntoIterator<Item = impl AsRef<str>>, options: &PathspecOptions, ) -> Result<Self, PathspecParseError>

Parse argv / from-file pathspec tokens without resolving against a work tree.

Work-tree-relative resolution and core.precomposeunicode normalization require Repository::pathspec.

Source

pub fn is_entire_tree(&self) -> bool

Whether the invocation limits paths (false = entire work tree).

Source

pub fn is_empty(&self) -> bool

Whether no path limit was given (alias of Self::is_entire_tree).

Source

pub fn common_prefix(&self) -> Option<&str>

Longest shared literal directory prefix across positive specs (Git tree narrowing).

Source

pub fn specs(&self) -> &[String]

Resolved work-tree-relative pathspec strings used for matching.

Source

pub fn iter(&self) -> impl Iterator<Item = &str>

User-facing spellings (argv or from-file lines) for messages and --json.

Source

pub fn globals(&self) -> PathspecGlobalFlags

Global pathspec flags active for this list.

Source

pub fn matches(&self, repo: &Repository, path: &str) -> Result<bool>

Whether path is selected in repo (positive match, no exclude).

§Errors

Same as Repository::pathspec_matcher.

Source

pub fn matches_entry( &self, repo: &Repository, path: &str, mode: u32, ) -> Result<bool>

Entry-aware matching (trailing /, submodules, :(attr:...)).

Source

pub fn matches_change( &self, repo: &Repository, path: &str, old_path: Option<&str>, ) -> Result<bool>

Whether a diff/staging change is selected (checks old_path for renames).

Source

pub fn matches_path(&self, path: &str) -> bool

Match using only pattern rules (no repository attributes); for tests and pure parsing.

Trait Implementations§

Source§

impl Clone for Pathspec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Pathspec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.