Struct git2::SubmoduleStatus [−][src]
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
[src]
pub const IN_HEAD: SubmoduleStatus
[src]
pub const IN_INDEX: SubmoduleStatus
[src]
pub const IN_CONFIG: SubmoduleStatus
[src]
pub const IN_WD: SubmoduleStatus
[src]
pub const INDEX_ADDED: SubmoduleStatus
[src]
pub const INDEX_DELETED: SubmoduleStatus
[src]
pub const INDEX_MODIFIED: SubmoduleStatus
[src]
pub const WD_UNINITIALIZED: SubmoduleStatus
[src]
pub const WD_ADDED: SubmoduleStatus
[src]
pub const WD_DELETED: SubmoduleStatus
[src]
pub const WD_MODIFIED: SubmoduleStatus
[src]
pub const WD_INDEX_MODIFIED: SubmoduleStatus
[src]
pub const WD_WD_MODIFIED: SubmoduleStatus
[src]
pub const WD_UNTRACKED: SubmoduleStatus
[src]
pub const fn empty() -> SubmoduleStatus
[src]
Returns an empty set of flags
pub const fn all() -> SubmoduleStatus
[src]
Returns the set containing all flags.
pub const fn bits(&self) -> u32
[src]
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<SubmoduleStatus>
[src]
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) -> SubmoduleStatus
[src]
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> SubmoduleStatus
[src]
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
[src]
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
[src]
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: SubmoduleStatus) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: SubmoduleStatus) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: SubmoduleStatus)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: SubmoduleStatus)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: SubmoduleStatus)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: SubmoduleStatus, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
impl SubmoduleStatus
[src]
pub fn is_in_head(&self) -> bool
[src]
pub fn is_in_index(&self) -> bool
[src]
pub fn is_in_config(&self) -> bool
[src]
pub fn is_in_wd(&self) -> bool
[src]
pub fn is_index_added(&self) -> bool
[src]
pub fn is_index_deleted(&self) -> bool
[src]
pub fn is_index_modified(&self) -> bool
[src]
pub fn is_wd_uninitialized(&self) -> bool
[src]
pub fn is_wd_added(&self) -> bool
[src]
pub fn is_wd_deleted(&self) -> bool
[src]
pub fn is_wd_modified(&self) -> bool
[src]
pub fn is_wd_wd_modified(&self) -> bool
[src]
pub fn is_wd_untracked(&self) -> bool
[src]
Trait Implementations
impl Binary for SubmoduleStatus
[src]
impl BitAnd<SubmoduleStatus> for SubmoduleStatus
[src]
type Output = SubmoduleStatus
The resulting type after applying the &
operator.
fn bitand(self, other: SubmoduleStatus) -> SubmoduleStatus
[src]
Returns the intersection between the two sets of flags.
impl BitAndAssign<SubmoduleStatus> for SubmoduleStatus
[src]
fn bitand_assign(&mut self, other: SubmoduleStatus)
[src]
Disables all flags disabled in the set.
impl BitOr<SubmoduleStatus> for SubmoduleStatus
[src]
type Output = SubmoduleStatus
The resulting type after applying the |
operator.
fn bitor(self, other: SubmoduleStatus) -> SubmoduleStatus
[src]
Returns the union of the two sets of flags.
impl BitOrAssign<SubmoduleStatus> for SubmoduleStatus
[src]
fn bitor_assign(&mut self, other: SubmoduleStatus)
[src]
Adds the set of flags.
impl BitXor<SubmoduleStatus> for SubmoduleStatus
[src]
type Output = SubmoduleStatus
The resulting type after applying the ^
operator.
fn bitxor(self, other: SubmoduleStatus) -> SubmoduleStatus
[src]
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<SubmoduleStatus> for SubmoduleStatus
[src]
fn bitxor_assign(&mut self, other: SubmoduleStatus)
[src]
Toggles the set of flags.
impl Clone for SubmoduleStatus
[src]
fn clone(&self) -> SubmoduleStatus
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for SubmoduleStatus
[src]
impl Debug for SubmoduleStatus
[src]
impl Eq for SubmoduleStatus
[src]
impl Extend<SubmoduleStatus> for SubmoduleStatus
[src]
fn extend<T: IntoIterator<Item = SubmoduleStatus>>(&mut self, iterator: T)
[src]
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl FromIterator<SubmoduleStatus> for SubmoduleStatus
[src]
fn from_iter<T: IntoIterator<Item = SubmoduleStatus>>(
iterator: T
) -> SubmoduleStatus
[src]
iterator: T
) -> SubmoduleStatus
impl Hash for SubmoduleStatus
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for SubmoduleStatus
[src]
impl Not for SubmoduleStatus
[src]
type Output = SubmoduleStatus
The resulting type after applying the !
operator.
fn not(self) -> SubmoduleStatus
[src]
Returns the complement of this set of flags.
impl Octal for SubmoduleStatus
[src]
impl Ord for SubmoduleStatus
[src]
fn cmp(&self, other: &SubmoduleStatus) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<SubmoduleStatus> for SubmoduleStatus
[src]
fn eq(&self, other: &SubmoduleStatus) -> bool
[src]
fn ne(&self, other: &SubmoduleStatus) -> bool
[src]
impl PartialOrd<SubmoduleStatus> for SubmoduleStatus
[src]
fn partial_cmp(&self, other: &SubmoduleStatus) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for SubmoduleStatus
[src]
impl StructuralPartialEq for SubmoduleStatus
[src]
impl Sub<SubmoduleStatus> for SubmoduleStatus
[src]
type Output = SubmoduleStatus
The resulting type after applying the -
operator.
fn sub(self, other: SubmoduleStatus) -> SubmoduleStatus
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<SubmoduleStatus> for SubmoduleStatus
[src]
fn sub_assign(&mut self, other: SubmoduleStatus)
[src]
Disables all flags enabled in the set.
impl UpperHex for SubmoduleStatus
[src]
Auto Trait Implementations
impl RefUnwindSafe for SubmoduleStatus
impl Send for SubmoduleStatus
impl Sync for SubmoduleStatus
impl Unpin for SubmoduleStatus
impl UnwindSafe for SubmoduleStatus
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,