Struct gix_pathspec::MagicSignature
source · pub struct MagicSignature(/* private fields */);
Expand description
Flags to represent ‘magic signatures’ which are parsed behind colons, like :top:
.
Implementations§
source§impl MagicSignature
impl MagicSignature
sourcepub const MUST_BE_DIR: Self = _
pub const MUST_BE_DIR: Self = _
The pattern must match a directory, and not a file.
This is equivalent to how it’s handled in gix-glob
source§impl MagicSignature
impl MagicSignature
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl MagicSignature
impl MagicSignature
sourcepub const fn iter(&self) -> Iter<MagicSignature>
pub const fn iter(&self) -> Iter<MagicSignature>
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.
sourcepub const fn iter_names(&self) -> IterNames<MagicSignature>
pub const fn iter_names(&self) -> IterNames<MagicSignature>
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.
Trait Implementations§
source§impl Binary for MagicSignature
impl Binary for MagicSignature
source§impl BitAnd for MagicSignature
impl BitAnd for MagicSignature
source§impl BitAndAssign for MagicSignature
impl BitAndAssign for MagicSignature
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for MagicSignature
impl BitOr for MagicSignature
source§fn bitor(self, other: MagicSignature) -> Self
fn bitor(self, other: MagicSignature) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = MagicSignature
type Output = MagicSignature
|
operator.source§impl BitOrAssign for MagicSignature
impl BitOrAssign for MagicSignature
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for MagicSignature
impl BitXor for MagicSignature
source§impl BitXorAssign for MagicSignature
impl BitXorAssign for MagicSignature
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for MagicSignature
impl Clone for MagicSignature
source§fn clone(&self) -> MagicSignature
fn clone(&self) -> MagicSignature
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MagicSignature
impl Debug for MagicSignature
source§impl Default for MagicSignature
impl Default for MagicSignature
source§fn default() -> MagicSignature
fn default() -> MagicSignature
source§impl Extend<MagicSignature> for MagicSignature
impl Extend<MagicSignature> for MagicSignature
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for MagicSignature
impl Flags for MagicSignature
source§const FLAGS: &'static [Flag<MagicSignature>] = _
const FLAGS: &'static [Flag<MagicSignature>] = _
source§fn from_bits_retain(bits: u32) -> MagicSignature
fn from_bits_retain(bits: u32) -> MagicSignature
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<MagicSignature> for MagicSignature
impl FromIterator<MagicSignature> for MagicSignature
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for MagicSignature
impl Hash for MagicSignature
source§impl IntoIterator for MagicSignature
impl IntoIterator for MagicSignature
source§impl LowerHex for MagicSignature
impl LowerHex for MagicSignature
source§impl Not for MagicSignature
impl Not for MagicSignature
source§impl Octal for MagicSignature
impl Octal for MagicSignature
source§impl Ord for MagicSignature
impl Ord for MagicSignature
source§fn cmp(&self, other: &MagicSignature) -> Ordering
fn cmp(&self, other: &MagicSignature) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for MagicSignature
impl PartialEq for MagicSignature
source§impl PartialOrd for MagicSignature
impl PartialOrd for MagicSignature
source§impl PublicFlags for MagicSignature
impl PublicFlags for MagicSignature
source§impl Sub for MagicSignature
impl Sub for MagicSignature
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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 = MagicSignature
type Output = MagicSignature
-
operator.source§impl SubAssign for MagicSignature
impl SubAssign for MagicSignature
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.
source§impl UpperHex for MagicSignature
impl UpperHex for MagicSignature
impl Copy for MagicSignature
impl Eq for MagicSignature
impl StructuralPartialEq for MagicSignature
Auto Trait Implementations§
impl Freeze for MagicSignature
impl RefUnwindSafe for MagicSignature
impl Send for MagicSignature
impl Sync for MagicSignature
impl Unpin for MagicSignature
impl UnwindSafe for MagicSignature
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)