Struct 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 - workdir contains untracked files

Implementations

impl SubmoduleStatus

pub const IN_HEAD: SubmoduleStatus

pub const IN_INDEX: SubmoduleStatus

pub const IN_CONFIG: SubmoduleStatus

pub const IN_WD: SubmoduleStatus

pub const INDEX_ADDED: SubmoduleStatus

pub const INDEX_DELETED: SubmoduleStatus

pub const INDEX_MODIFIED: SubmoduleStatus

pub const WD_UNINITIALIZED: SubmoduleStatus

pub const WD_ADDED: SubmoduleStatus

pub const WD_DELETED: SubmoduleStatus

pub const WD_MODIFIED: SubmoduleStatus

pub const WD_INDEX_MODIFIED: SubmoduleStatus

pub const WD_WD_MODIFIED: SubmoduleStatus

pub const WD_UNTRACKED: SubmoduleStatus

impl SubmoduleStatus

pub const fn empty() -> SubmoduleStatus

Get a flags value with all bits unset.

pub const fn all() -> SubmoduleStatus

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> SubmoduleStatus

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<SubmoduleStatus>

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.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

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.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

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.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> SubmoduleStatus

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl SubmoduleStatus

pub const fn iter(&self) -> Iter<SubmoduleStatus>

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.

pub const fn iter_names(&self) -> IterNames<SubmoduleStatus>

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.

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<(), Error>

Formats the value using the given formatter.

impl BitAnd for SubmoduleStatus

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

The bitwise and (&) of the bits in two flags values.

type Output = SubmoduleStatus

The resulting type after applying the & operator.

impl BitAndAssign for SubmoduleStatus

fn bitand_assign(&mut self, other: SubmoduleStatus)

The bitwise and (&) of the bits in two flags values.

impl BitOr for SubmoduleStatus

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

The bitwise or (|) of the bits in two flags values.

type Output = SubmoduleStatus

The resulting type after applying the | operator.

impl BitOrAssign for SubmoduleStatus

fn bitor_assign(&mut self, other: SubmoduleStatus)

The bitwise or (|) of the bits in two flags values.

impl BitXor for SubmoduleStatus

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = SubmoduleStatus

The resulting type after applying the ^ operator.

impl BitXorAssign for SubmoduleStatus

fn bitxor_assign(&mut self, other: SubmoduleStatus)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for SubmoduleStatus

fn clone(&self) -> SubmoduleStatus

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Extend<SubmoduleStatus> for SubmoduleStatus

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = SubmoduleStatus>,

The bitwise or (|) of the bits in each flags value.

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

const FLAGS: &'static [Flag<SubmoduleStatus>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> SubmoduleStatus

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<SubmoduleStatus> for SubmoduleStatus

fn from_iter<T>(iterator: T) -> SubmoduleStatus

where T: IntoIterator<Item = SubmoduleStatus>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for SubmoduleStatus

type Item = SubmoduleStatus

The type of the elements being iterated over.

type IntoIter = Iter<SubmoduleStatus>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <SubmoduleStatus as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for SubmoduleStatus

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

Formats the value using the given formatter.

impl Not for SubmoduleStatus

fn not(self) -> SubmoduleStatus

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = SubmoduleStatus

The resulting type after applying the ! operator.

impl Octal for SubmoduleStatus

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

Formats the value using the given formatter.

impl PartialEq for SubmoduleStatus

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Sub for SubmoduleStatus

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

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

The resulting type after applying the - operator.

impl SubAssign for SubmoduleStatus

fn sub_assign(&mut self, other: SubmoduleStatus)

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

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

Formats the value using the given formatter.

impl Copy for SubmoduleStatus

impl Eq for SubmoduleStatus

impl StructuralPartialEq for SubmoduleStatus