Struct PathspecFlags

pub struct PathspecFlags(/* private fields */);

…

Implementations

impl PathspecFlags

pub const DEFAULT: PathspecFlags

Use the default pathspec matching configuration.

pub const IGNORE_CASE: PathspecFlags

Force matching to ignore case, otherwise matching will use native case sensitivity of the platform filesystem.

pub const USE_CASE: PathspecFlags

Force case sensitive matches, otherwise match will use the native case sensitivity of the platform filesystem.

pub const NO_GLOB: PathspecFlags

Disable glob patterns and just use simple string comparison for matching.

pub const NO_MATCH_ERROR: PathspecFlags

Means that match functions return the error code NotFound if no matches are found. By default no matches is a success.

pub const FIND_FAILURES: PathspecFlags

Means that the list returned should track which patterns matched which files so that at the end of the match we can identify patterns that did not match any files.

pub const FAILURES_ONLY: PathspecFlags

Means that the list returned does not need to keep the actual matching filenames. Use this to just test if there were any matches at all or in combination with PATHSPEC_FAILURES to validate a pathspec.

impl PathspecFlags

pub const fn empty() -> PathspecFlags

Get a flags value with all bits unset.

pub const fn all() -> PathspecFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<PathspecFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> PathspecFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> PathspecFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<PathspecFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: PathspecFlags) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: PathspecFlags) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: PathspecFlags)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: PathspecFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: PathspecFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: PathspecFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: PathspecFlags) -> PathspecFlags

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: PathspecFlags) -> PathspecFlags

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: PathspecFlags) -> PathspecFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: PathspecFlags) -> PathspecFlags

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> PathspecFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl PathspecFlags

pub const fn iter(&self) -> Iter<PathspecFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<PathspecFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl PathspecFlags

pub fn is_default(&self) -> bool

pub fn is_ignore_case(&self) -> bool

pub fn is_use_case(&self) -> bool

pub fn is_no_glob(&self) -> bool

pub fn is_no_match_error(&self) -> bool

pub fn is_find_failures(&self) -> bool

pub fn is_failures_only(&self) -> bool

Trait Implementations

impl Binary for PathspecFlags

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

Formats the value using the given formatter.

impl BitAnd for PathspecFlags

fn bitand(self, other: PathspecFlags) -> PathspecFlags

The bitwise and (&) of the bits in two flags values.

type Output = PathspecFlags

The resulting type after applying the & operator.

impl BitAndAssign for PathspecFlags

fn bitand_assign(&mut self, other: PathspecFlags)

The bitwise and (&) of the bits in two flags values.

impl BitOr for PathspecFlags

fn bitor(self, other: PathspecFlags) -> PathspecFlags

The bitwise or (|) of the bits in two flags values.

type Output = PathspecFlags

The resulting type after applying the | operator.

impl BitOrAssign for PathspecFlags

fn bitor_assign(&mut self, other: PathspecFlags)

The bitwise or (|) of the bits in two flags values.

impl BitXor for PathspecFlags

fn bitxor(self, other: PathspecFlags) -> PathspecFlags

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = PathspecFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for PathspecFlags

fn bitxor_assign(&mut self, other: PathspecFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for PathspecFlags

fn clone(&self) -> PathspecFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathspecFlags

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

Formats the value using the given formatter.

impl Default for PathspecFlags

fn default() -> PathspecFlags

Returns the “default value” for a type.

impl Extend<PathspecFlags> for PathspecFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = PathspecFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for PathspecFlags

const FLAGS: &'static [Flag<PathspecFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> PathspecFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<PathspecFlags> for PathspecFlags

fn from_iter<T>(iterator: T) -> PathspecFlags

where T: IntoIterator<Item = PathspecFlags>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for PathspecFlags

type Item = PathspecFlags

The type of the elements being iterated over.

type IntoIter = Iter<PathspecFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <PathspecFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for PathspecFlags

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

Formats the value using the given formatter.

impl Not for PathspecFlags

fn not(self) -> PathspecFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = PathspecFlags

The resulting type after applying the ! operator.

impl Octal for PathspecFlags

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

Formats the value using the given formatter.

impl PartialEq for PathspecFlags

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

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

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 Sub for PathspecFlags

fn sub(self, other: PathspecFlags) -> PathspecFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = PathspecFlags

The resulting type after applying the - operator.

impl SubAssign for PathspecFlags

fn sub_assign(&mut self, other: PathspecFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for PathspecFlags

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

Formats the value using the given formatter.

impl Copy for PathspecFlags

impl Eq for PathspecFlags

impl StructuralPartialEq for PathspecFlags