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.

Trait Implementations

impl Copy for SubmoduleStatus

impl PartialEq for SubmoduleStatus

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

This method tests for !=.

impl Eq for SubmoduleStatus

impl Clone for SubmoduleStatus

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl PartialOrd for SubmoduleStatus

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

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

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

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

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

impl Ord for SubmoduleStatus

This method returns an Ordering between self and other. Read more

[src]

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

Compares and returns the maximum of two values. Read more

[src]

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

Compares and returns the minimum of two values. Read more

impl Hash for SubmoduleStatus

Feeds this value into the given [Hasher]. Read more

1.3.0
[src]

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

impl Debug for SubmoduleStatus

Formats the value using the given formatter.

impl Binary for SubmoduleStatus

Formats the value using the given formatter.

impl Octal for SubmoduleStatus

Formats the value using the given formatter.

impl LowerHex for SubmoduleStatus

Formats the value using the given formatter.

impl UpperHex for SubmoduleStatus

Formats the value using the given formatter.

impl BitOr for SubmoduleStatus

The resulting type after applying the | operator.

Returns the union of the two sets of flags.

impl BitOrAssign for SubmoduleStatus

Adds the set of flags.

impl BitXor for SubmoduleStatus

The resulting type after applying the ^ operator.

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

impl BitXorAssign for SubmoduleStatus

Toggles the set of flags.

impl BitAnd for SubmoduleStatus

The resulting type after applying the & operator.

Returns the intersection between the two sets of flags.

impl BitAndAssign for SubmoduleStatus

Disables all flags disabled in the set.

impl Sub for SubmoduleStatus

The resulting type after applying the - operator.

Returns the set difference of the two sets of flags.

impl SubAssign 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 Extend<SubmoduleStatus> for SubmoduleStatus

Extends a collection with the contents of an iterator. Read more

impl FromIterator<SubmoduleStatus> for SubmoduleStatus

Creates a value from an iterator. Read more