pub struct Flags(/* private fields */);
Expand description
In-memory flags.
Notably, not all of these will be persisted but can be used to aid all kinds of operations.
Implementations§
source§impl Flags
impl Flags
sourcepub const PATH_LEN: Self = _
pub const PATH_LEN: Self = _
The mask to obtain the length of the path associated with this entry, up to 4095 characters without extension.
sourcepub const STAGE_MASK: Self = _
pub const STAGE_MASK: Self = _
The mask to apply to obtain the stage number of an entry, encoding three value: 0 = base, 1 = ours, 2 = theirs.
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 = _
Created with git add --intent-to-add
to mark empty entries that have their counter-part in the worktree, but not
yet in the object database.
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
source§impl Flags
impl Flags
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 Flags
impl Flags
sourcepub const fn iter(&self) -> Iter<Flags>
pub const fn iter(&self) -> Iter<Flags>
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<Flags>
pub const fn iter_names(&self) -> IterNames<Flags>
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.
source§impl Flags
impl Flags
sourcepub fn stage_raw(&self) -> u32
pub fn stage_raw(&self) -> u32
Return an entry’s stage as raw number between 0 and 4. Possible values are:
- 0 = no conflict,
- 1 = base,
- 2 = ours,
- 3 = theirs
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 for Flags
impl BitAndAssign for Flags
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 BitOrAssign for Flags
impl BitOrAssign for Flags
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 BitXorAssign for Flags
impl BitXorAssign for Flags
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 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)
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 Flags
impl Flags for Flags
source§fn from_bits_retain(bits: u32) -> Flags
fn from_bits_retain(bits: u32) -> Flags
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<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
The bitwise or (|
) of the bits in each flags value.
source§impl IntoIterator for Flags
impl IntoIterator for Flags
source§impl PartialEq for Flags
impl PartialEq for Flags
source§impl Sub for Flags
impl Sub for Flags
source§impl SubAssign for Flags
impl SubAssign for Flags
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.
impl Copy for Flags
impl Eq for Flags
impl StructuralPartialEq for Flags
Auto Trait Implementations§
impl Freeze for Flags
impl RefUnwindSafe for Flags
impl Send for Flags
impl Sync for Flags
impl Unpin for Flags
impl UnwindSafe for Flags
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)