[]Struct git2::SubmoduleStatus

pub struct SubmoduleStatus { /* fields omitted */ }

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

Methods

impl SubmoduleStatus

Returns an empty set of flags.

Returns the set containing all flags.

Returns the raw value of the flags currently stored.

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

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

Returns true if no flags are currently stored.

Returns true if all flags are currently set.

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

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

Inserts the specified flags in-place.

Removes the specified flags in-place.

Toggles the specified flags in-place.

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

impl SubmoduleStatus
[src]

Trait Implementations

impl Clone for SubmoduleStatus

Performs copy-assignment from source. Read more

impl Extend<SubmoduleStatus> for SubmoduleStatus

impl Copy for SubmoduleStatus

impl Eq for SubmoduleStatus

impl PartialOrd<SubmoduleStatus> for SubmoduleStatus

impl PartialEq<SubmoduleStatus> for SubmoduleStatus

impl Ord for SubmoduleStatus

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl Debug for SubmoduleStatus

impl Sub<SubmoduleStatus> for SubmoduleStatus

The resulting type after applying the - operator.

Returns the set difference of the two sets of flags.

impl SubAssign<SubmoduleStatus> for SubmoduleStatus

Disables all flags enabled in the set.

impl Not for SubmoduleStatus

The resulting type after applying the ! operator.

Returns the complement of this set of flags.

impl BitAnd<SubmoduleStatus> for SubmoduleStatus

The resulting type after applying the & operator.

Returns the intersection between the two sets of flags.

impl BitOr<SubmoduleStatus> for SubmoduleStatus

The resulting type after applying the | operator.

Returns the union of the two sets of flags.

impl BitXor<SubmoduleStatus> for SubmoduleStatus

The resulting type after applying the ^ operator.

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

impl BitAndAssign<SubmoduleStatus> for SubmoduleStatus

Disables all flags disabled in the set.

impl BitOrAssign<SubmoduleStatus> for SubmoduleStatus

Adds the set of flags.

impl BitXorAssign<SubmoduleStatus> for SubmoduleStatus

Toggles the set of flags.

impl Hash for SubmoduleStatus

Feeds a slice of this type into the given [Hasher]. Read more

impl FromIterator<SubmoduleStatus> for SubmoduleStatus

impl Octal for SubmoduleStatus

impl Binary for SubmoduleStatus

impl LowerHex for SubmoduleStatus

impl UpperHex for SubmoduleStatus

Auto Trait Implementations

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]