pub struct Flags { /* private fields */ }
Expand description
In-memory flags
Implementations§
source§impl Flags
impl Flags
sourcepub const STAGE_MASK: Self = _
pub const STAGE_MASK: Self = _
The mask to apply to obtain the stage number of an entry.
sourcepub const PATH_LEN: Self = _
pub const PATH_LEN: Self = _
The mask to obtain the length of the path associated with this entry.
sourcepub const ASSUME_VALID: Self = _
pub const ASSUME_VALID: Self = _
If set, the entry be assumed to match with the version on the working tree, as a way to avoid lstat()
checks.
sourcepub const UPDATE: Self = _
pub const UPDATE: Self = _
Indicates that an entry needs to be updated as it’s in-memory representation doesn’t match what’s on disk.
sourcepub const REMOVE: Self = _
pub const REMOVE: Self = _
Indicates an entry should be removed - this typically happens during writing, by simply skipping over them.
sourcepub const FSMONITOR_VALID: Self = _
pub const FSMONITOR_VALID: Self = _
Set if the filesystem monitor is valid.
sourcepub const WORKTREE_REMOVE: Self = _
pub const WORKTREE_REMOVE: Self = _
Remove in work directory
sourcepub const CONFLICTED: Self = _
pub const CONFLICTED: Self = _
Set to indicate the entry exists in multiple stages at once due to conflicts.
sourcepub const NEW_SKIP_WORKTREE: Self = _
pub const NEW_SKIP_WORKTREE: Self = _
Only temporarily used by unpack_trees() (in C)
sourcepub const PATHSPEC_MATCHED: Self = _
pub const PATHSPEC_MATCHED: Self = _
temporarily mark paths matched by a path spec
sourcepub const UPDATE_IN_BASE: Self = _
pub const UPDATE_IN_BASE: Self = _
When the index is split, this indicates the entry is up-to-date in the shared portion of the index.
sourcepub const STRIP_NAME: Self = _
pub const STRIP_NAME: Self = _
Indicates the entry name is present in the base/shared index, and thus doesn’t have to be stored in this one.
sourcepub const INTENT_TO_ADD: Self = _
pub const INTENT_TO_ADD: Self = _
stored at rest, see at_rest::FlagsExtended
sourcepub const SKIP_WORKTREE: Self = _
pub const SKIP_WORKTREE: Self = _
Stored at rest
sourcepub const EXTENDED_2: Self = _
pub const EXTENDED_2: Self = _
For future extension
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl Flags
impl Flags
sourcepub fn to_storage(self) -> Flags
pub fn to_storage(self) -> Flags
Transform ourselves to a storage representation to keep all flags which are to be persisted,
skipping all extended flags. Note that the caller has to check for the EXTENDED
bit to be present
and write extended flags as well if so.
Trait Implementations§
source§impl BitAndAssign<Flags> for Flags
impl BitAndAssign<Flags> for Flags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign<Flags> for Flags
impl BitOrAssign<Flags> for Flags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<Flags> for Flags
impl BitXorAssign<Flags> for Flags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<Flags> for Flags
impl Extend<Flags> for Flags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<Flags> for Flags
impl FromIterator<Flags> for Flags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for Flags
impl Ord for Flags
source§impl PartialEq<Flags> for Flags
impl PartialEq<Flags> for Flags
source§impl PartialOrd<Flags> for Flags
impl PartialOrd<Flags> for Flags
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign<Flags> for Flags
impl SubAssign<Flags> for Flags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.