Struct git2::SubmoduleStatus

pub struct SubmoduleStatus { /* private fields */ }

Return codes for submodule status.

A combination of these flags will be returned to describe the status of a submodule. Depending on the “ignore” property of the submodule, some of the flags may never be returned because they indicate changes that are supposed to be ignored.

Submodule info is contained in 4 places: the HEAD tree, the index, config files (both .git/config and .gitmodules), and the working directory. Any or all of those places might be missing information about the submodule depending on what state the repo is in. We consider all four places to build the combination of status flags.

There are four values that are not really status, but give basic info about what sources of submodule data are available. These will be returned even if ignore is set to “ALL”.

• IN_HEAD - superproject head contains submodule
• IN_INDEX - superproject index contains submodule
• IN_CONFIG - superproject gitmodules has submodule
• IN_WD - superproject workdir has submodule

The following values will be returned so long as ignore is not “ALL”.

• INDEX_ADDED - in index, not in head
• INDEX_DELETED - in head, not in index
• INDEX_MODIFIED - index and head don’t match
• WD_UNINITIALIZED - workdir contains empty directory
• WD_ADDED - in workdir, not index
• WD_DELETED - in index, not workdir
• WD_MODIFIED - index and workdir head don’t match

The following can only be returned if ignore is “NONE” or “UNTRACKED”.

• WD_INDEX_MODIFIED - submodule workdir index is dirty
• WD_WD_MODIFIED - submodule workdir has modified files

Lastly, the following will only be returned for ignore “NONE”.

• WD_UNTRACKED - wd contains untracked files

Implementations

impl SubmoduleStatus

pub const IN_HEAD: Self

pub const IN_INDEX: Self

pub const IN_CONFIG: Self

pub const IN_WD: Self

pub const INDEX_ADDED: Self

pub const INDEX_DELETED: Self

pub const INDEX_MODIFIED: Self

pub const WD_UNINITIALIZED: Self

pub const WD_ADDED: Self

pub const WD_DELETED: Self

pub const WD_MODIFIED: Self

pub const WD_INDEX_MODIFIED: Self

pub const WD_WD_MODIFIED: Self

pub const WD_UNTRACKED: Self

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

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<Self>

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) -> Self

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

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.

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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.

impl SubmoduleStatus

pub fn is_in_head(&self) -> bool

pub fn is_in_index(&self) -> bool

pub fn is_in_config(&self) -> bool

pub fn is_in_wd(&self) -> bool

pub fn is_index_added(&self) -> bool

pub fn is_index_deleted(&self) -> bool

pub fn is_index_modified(&self) -> bool

pub fn is_wd_uninitialized(&self) -> bool

pub fn is_wd_added(&self) -> bool

pub fn is_wd_deleted(&self) -> bool

pub fn is_wd_modified(&self) -> bool

pub fn is_wd_wd_modified(&self) -> bool

pub fn is_wd_untracked(&self) -> bool

Trait Implementations

impl Binary for SubmoduleStatus

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

Formats the value using the given formatter.

impl BitAnd<SubmoduleStatus> for SubmoduleStatus

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

Returns the intersection between the two sets of flags.

type Output = Self

The resulting type after applying the & operator.

impl BitAndAssign<SubmoduleStatus> for SubmoduleStatus

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<SubmoduleStatus> for SubmoduleStatus

fn bitor(self, other: SubmoduleStatus) -> Self

Returns the union of the two sets of flags.

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<SubmoduleStatus> for SubmoduleStatus

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<SubmoduleStatus> for SubmoduleStatus

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

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

type Output = Self

The resulting type after applying the ^ operator.

impl BitXorAssign<SubmoduleStatus> for SubmoduleStatus

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for SubmoduleStatus

fn clone(&self) -> SubmoduleStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubmoduleStatus

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

Formats the value using the given formatter.

impl Extend<SubmoduleStatus> for SubmoduleStatus

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

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<SubmoduleStatus> for SubmoduleStatus

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for SubmoduleStatus

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

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 SubmoduleStatus

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

Formats the value using the given formatter.

impl Not for SubmoduleStatus

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Self

The resulting type after applying the ! operator.

impl Octal for SubmoduleStatus

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

Formats the value using the given formatter.

impl Ord for SubmoduleStatus

fn cmp(&self, other: &SubmoduleStatus) -> 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

Restrict a value to a certain interval.

impl PartialEq<SubmoduleStatus> for SubmoduleStatus

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

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

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

This method tests for !=.

impl PartialOrd<SubmoduleStatus> for SubmoduleStatus

fn partial_cmp(&self, other: &SubmoduleStatus) -> 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<SubmoduleStatus> for SubmoduleStatus

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

Returns the set difference of the two sets of flags.

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<SubmoduleStatus> for SubmoduleStatus

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for SubmoduleStatus

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

Formats the value using the given formatter.

impl Copy for SubmoduleStatus

impl Eq for SubmoduleStatus

impl StructuralEq for SubmoduleStatus

impl StructuralPartialEq for SubmoduleStatus