Struct git_repository::index::entry::Flags

pub struct Flags { /* private fields */ }

Available on crate feature unstable only.

In-memory flags

Implementations

impl Flags

pub const STAGE_MASK: Flags = Self{ bits: 12288,}

The mask to apply to obtain the stage number of an entry.

pub const EXTENDED: Flags = Self{ bits: 16384,}

If set, additional bits need to be written to storage.

pub const PATH_LEN: Flags = Self{ bits: 4095,}

The mask to obtain the length of the path associated with this entry.

pub const ASSUME_VALID: Flags = Self{ bits: 1 << 15,}

If set, the entry be assumed to match with the version on the working tree, as a way to avoid lstat() checks.

pub const UPDATE: Flags = Self{ bits: 1 << 16,}

Indicates that an entry needs to be updated as it’s in-memory representation doesn’t match what’s on disk.

pub const REMOVE: Flags = Self{ bits: 1 << 17,}

Indicates an entry should be removed - this typically happens during writing, by simply skipping over them.

pub const UPTODATE: Flags = Self{ bits: 1 << 18,}

Indicates that an entry is known to be uptodate.

pub const ADDED: Flags = Self{ bits: 1 << 19,}

Only temporarily used by unpack_trees() (in C)

pub const HASHED: Flags = Self{ bits: 1 << 20,}

Whether an up-to-date object hash exists for the entry.

pub const FSMONITOR_VALID: Flags = Self{ bits: 1 << 21,}

Set if the filesystem monitor is valid.

pub const WORKTREE_REMOVE: Flags = Self{ bits: 1 << 22,}

Remove in work directory

pub const CONFLICTED: Flags = Self{ bits: 1 << 23,}

Set to indicate the entry exists in multiple stages at once due to conflicts.

pub const UNPACKED: Flags = Self{ bits: 1 << 24,}

Indicates that the entry was already turned into a tree.

pub const NEW_SKIP_WORKTREE: Flags = Self{ bits: 1 << 25,}

Only temporarily used by unpack_trees() (in C)

pub const PATHSPEC_MATCHED: Flags = Self{ bits: 1 << 26,}

temporarily mark paths matched by a path spec

pub const UPDATE_IN_BASE: Flags = Self{ bits: 1 << 27,}

When the index is split, this indicates the entry is up-to-date in the shared portion of the index.

pub const STRIP_NAME: Flags = Self{ bits: 1 << 28,}

Indicates the entry name is present in the base/shared index, and thus doesn’t have to be stored in this one.

pub const INTENT_TO_ADD: Flags = Self{ bits: 1 << 29,}

stored at rest, see at_rest::FlagsExtended

pub const SKIP_WORKTREE: Flags = Self{ bits: 1 << 30,}

Stored at rest

pub const EXTENDED_2: Flags = Self{ bits: 1 << 31,}

For future extension

pub const fn empty() -> Flags

Returns an empty set of flags.

pub const fn all() -> Flags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Flags

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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

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.

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

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.

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

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.

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

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.

pub const fn complement(self) -> Flags

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.

impl Flags

pub fn stage(&self) -> u32

Return the stage as extracted from the bits of this instance.

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

impl Binary for Flags

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

Formats the value using the given formatter.

impl BitAnd<Flags> for Flags

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

Returns the intersection between the two sets of flags.

type Output = Flags

The resulting type after applying the & operator.

impl BitAndAssign<Flags> for Flags

fn bitand_assign(&mut self, other: Flags)

Disables all flags disabled in the set.

impl BitOr<Flags> for Flags

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

Returns the union of the two sets of flags.

type Output = Flags

The resulting type after applying the | operator.

impl BitOrAssign<Flags> for Flags

fn bitor_assign(&mut self, other: Flags)

Adds the set of flags.

impl BitXor<Flags> for Flags

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

Returns the left flags, but with all the right flags toggled.

type Output = Flags

The resulting type after applying the ^ operator.

impl BitXorAssign<Flags> for Flags

fn bitxor_assign(&mut self, other: Flags)

Toggles the set of flags.

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Extend<Flags> for Flags

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = Flags>, 

Extends a collection with the contents of an iterator.

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 FromIterator<Flags> for Flags

fn from_iter<T>(iterator: T) -> Flags where
    T: IntoIterator<Item = Flags>, 

Creates a value from an iterator.

impl Hash for Flags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for Flags

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

Formats the value using the given formatter.

impl Not for Flags

fn not(self) -> Flags

Returns the complement of this set of flags.

type Output = Flags

The resulting type after applying the ! operator.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Ord for Flags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Flags> for Flags

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Flags> for Flags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Flags> for Flags

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

Returns the set difference of the two sets of flags.

type Output = Flags

The resulting type after applying the - operator.

impl SubAssign<Flags> for Flags

fn sub_assign(&mut self, other: Flags)

Disables all flags enabled in the set.

impl UpperHex for Flags

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

Formats the value using the given formatter.

impl Copy for Flags

impl Eq for Flags

impl StructuralEq for Flags

impl StructuralPartialEq for Flags