gix::worktree::glob

Struct Pattern

pub struct Pattern {
    pub text: BString,
    pub mode: Mode,
    pub first_wildcard_pos: Option<usize>,
}

Available on crate feature excludes only.

Expand description

A glob pattern optimized for matching paths relative to a root directory.

For normal globbing, use wildmatch() instead.

Fields§

§text: BString

the actual pattern bytes

§mode: Mode

Additional information to help accelerate pattern matching.

§first_wildcard_pos: Option<usize>

The position in text with the first wildcard character, or None if there is no wildcard at all.

Implementations§

impl Pattern

Instantiation

pub fn from_bytes(text: &[u8]) -> Option<Pattern>

Available on crate feature attributes only.

Parse the given text as pattern, or return None if text was empty.

pub fn from_bytes_without_negation(text: &[u8]) -> Option<Pattern>

Available on crate feature attributes only.

Parse the given text as pattern without supporting leading ! or \\! , or return None if text was empty.

This assures that text remains entirely unaltered, but removes built-in support for negation as well.

impl Pattern

Access

pub fn is_negative(&self) -> bool

Available on crate feature attributes only.

Return true if a match is negated.

pub fn matches_repo_relative_path( &self, path: &BStr, basename_start_pos: Option<usize>, is_dir: Option<bool>, case: Case, mode: Mode, ) -> bool

Available on crate feature attributes only.

Match the given path which takes slashes (and only slashes) literally, and is relative to the repository root. Note that path is assumed to be relative to the repository.

We may take various shortcuts which is when basename_start_pos and is_dir come into play. basename_start_pos is the index at which the path’s basename starts.

case folding can be configured as well. mode is used to control how crate::wildmatch() should operate.

pub fn matches(&self, value: &BStr, mode: Mode) -> bool

Available on crate feature attributes only.

See if value matches this pattern in the given mode.

mode can identify value as path which won’t match the slash character, and can match strings with cases ignored as well. Note that the case folding performed here is ASCII only.

Note that this method uses some shortcuts to accelerate simple patterns, but falls back to wildmatch() if these fail.

Trait Implementations§

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Pattern

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Pattern

fn deserialize<D>( deserializer: D, ) -> Result<Pattern, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for Pattern

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

Formats the value using the given formatter. Read more

impl Hash for Pattern

fn hash<H>(&self, state: &mut H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl Ord for Pattern

fn cmp(&self, other: &Pattern) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

impl PartialEq for Pattern

fn eq(&self, other: &Pattern) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Pattern

fn partial_cmp(&self, other: &Pattern) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Serialize for Pattern

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Eq for Pattern

impl StructuralPartialEq for Pattern

Auto Trait Implementations§

impl Freeze for Pattern

impl RefUnwindSafe for Pattern

impl Send for Pattern

impl Sync for Pattern

impl Unpin for Pattern

impl UnwindSafe for Pattern

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where 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>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,