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
impl SubmoduleStatus
pub const IN_HEAD: SubmoduleStatus
IN_HEAD: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_IN_HEAD as u32,}
pub const IN_INDEX: SubmoduleStatus
IN_INDEX: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_IN_INDEX as u32,}
pub const IN_CONFIG: SubmoduleStatus
IN_CONFIG: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_IN_CONFIG as u32,}
pub const IN_WD: SubmoduleStatus
IN_WD: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_IN_WD as u32,}
pub const INDEX_ADDED: SubmoduleStatus
INDEX_ADDED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_INDEX_ADDED as u32,}
pub const INDEX_DELETED: SubmoduleStatus
INDEX_DELETED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_INDEX_DELETED as u32,}
pub const INDEX_MODIFIED: SubmoduleStatus
INDEX_MODIFIED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_INDEX_MODIFIED as u32,}
pub const WD_UNINITIALIZED: SubmoduleStatus
WD_UNINITIALIZED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_WD_UNINITIALIZED as u32,}
pub const WD_ADDED: SubmoduleStatus
WD_ADDED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_WD_ADDED as u32,}
pub const WD_DELETED: SubmoduleStatus
WD_DELETED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_WD_DELETED as u32,}
pub const WD_MODIFIED: SubmoduleStatus
WD_MODIFIED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_WD_MODIFIED as u32,}
pub const WD_INDEX_MODIFIED: SubmoduleStatus
WD_INDEX_MODIFIED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED as u32,}
pub const WD_WD_MODIFIED: SubmoduleStatus
WD_WD_MODIFIED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_WD_WD_MODIFIED as u32,}
pub const WD_UNTRACKED: SubmoduleStatus
WD_UNTRACKED: SubmoduleStatus = SubmoduleStatus{bits: raw::GIT_SUBMODULE_STATUS_WD_UNTRACKED as u32,}
pub fn empty() -> SubmoduleStatus
pub fn empty() -> SubmoduleStatus
Returns an empty set of flags.
pub fn all() -> SubmoduleStatus
pub fn all() -> SubmoduleStatus
Returns the set containing all flags.
pub fn bits(&self) -> u32
pub fn bits(&self) -> u32
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<SubmoduleStatus>
pub fn from_bits(bits: u32) -> Option<SubmoduleStatus>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub fn from_bits_truncate(bits: u32) -> SubmoduleStatus
pub fn from_bits_truncate(bits: u32) -> SubmoduleStatus
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
pub fn is_all(&self) -> bool
pub fn is_all(&self) -> bool
Returns true
if all flags are currently set.
pub fn intersects(&self, other: SubmoduleStatus) -> bool
pub fn intersects(&self, other: SubmoduleStatus) -> bool
Returns true
if there are flags common to both self
and other
.
pub fn contains(&self, other: SubmoduleStatus) -> bool
pub fn contains(&self, other: SubmoduleStatus) -> bool
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: SubmoduleStatus)
pub fn insert(&mut self, other: SubmoduleStatus)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: SubmoduleStatus)
pub fn remove(&mut self, other: SubmoduleStatus)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: SubmoduleStatus)
pub fn toggle(&mut self, other: SubmoduleStatus)
Toggles the specified flags in-place.
pub fn set(&mut self, other: SubmoduleStatus, value: bool)
pub fn set(&mut self, other: SubmoduleStatus, value: bool)
Inserts or removes the specified flags depending on the passed value.
impl SubmoduleStatus
[src]
impl SubmoduleStatus
pub fn is_in_head(&self) -> bool
[src]
pub fn is_in_head(&self) -> bool
pub fn is_in_index(&self) -> bool
[src]
pub fn is_in_index(&self) -> bool
pub fn is_in_config(&self) -> bool
[src]
pub fn is_in_config(&self) -> bool
pub fn is_in_wd(&self) -> bool
[src]
pub fn is_in_wd(&self) -> bool
pub fn is_index_added(&self) -> bool
[src]
pub fn is_index_added(&self) -> bool
pub fn is_index_deleted(&self) -> bool
[src]
pub fn is_index_deleted(&self) -> bool
pub fn is_index_modified(&self) -> bool
[src]
pub fn is_index_modified(&self) -> bool
pub fn is_wd_uninitialized(&self) -> bool
[src]
pub fn is_wd_uninitialized(&self) -> bool
pub fn is_wd_added(&self) -> bool
[src]
pub fn is_wd_added(&self) -> bool
pub fn is_wd_deleted(&self) -> bool
[src]
pub fn is_wd_deleted(&self) -> bool
pub fn is_wd_modified(&self) -> bool
[src]
pub fn is_wd_modified(&self) -> bool
pub fn is_wd_wd_modified(&self) -> bool
[src]
pub fn is_wd_wd_modified(&self) -> bool
pub fn is_wd_untracked(&self) -> bool
[src]
pub fn is_wd_untracked(&self) -> bool
Trait Implementations
impl Copy for SubmoduleStatus
impl Copy for SubmoduleStatus
impl PartialEq for SubmoduleStatus
impl PartialEq for SubmoduleStatus
fn eq(&self, other: &SubmoduleStatus) -> bool
fn eq(&self, other: &SubmoduleStatus) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &SubmoduleStatus) -> bool
fn ne(&self, other: &SubmoduleStatus) -> bool
This method tests for !=
.
impl Eq for SubmoduleStatus
impl Eq for SubmoduleStatus
impl Clone for SubmoduleStatus
impl Clone for SubmoduleStatus
fn clone(&self) -> SubmoduleStatus
fn clone(&self) -> SubmoduleStatus
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl PartialOrd for SubmoduleStatus
impl PartialOrd for SubmoduleStatus
fn partial_cmp(&self, other: &SubmoduleStatus) -> Option<Ordering>
fn partial_cmp(&self, other: &SubmoduleStatus) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &SubmoduleStatus) -> bool
fn lt(&self, other: &SubmoduleStatus) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &SubmoduleStatus) -> bool
fn le(&self, other: &SubmoduleStatus) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &SubmoduleStatus) -> bool
fn gt(&self, other: &SubmoduleStatus) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &SubmoduleStatus) -> bool
fn ge(&self, other: &SubmoduleStatus) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for SubmoduleStatus
impl Ord for SubmoduleStatus
fn cmp(&self, other: &SubmoduleStatus) -> Ordering
fn cmp(&self, other: &SubmoduleStatus) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl Hash for SubmoduleStatus
impl Hash for SubmoduleStatus
fn hash<__H: Hasher>(&self, state: &mut __H)
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Debug for SubmoduleStatus
impl Debug for SubmoduleStatus
impl Binary for SubmoduleStatus
impl Binary for SubmoduleStatus
impl Octal for SubmoduleStatus
impl Octal for SubmoduleStatus
impl LowerHex for SubmoduleStatus
impl LowerHex for SubmoduleStatus
impl UpperHex for SubmoduleStatus
impl UpperHex for SubmoduleStatus
impl BitOr for SubmoduleStatus
impl BitOr for SubmoduleStatus
type Output = SubmoduleStatus
The resulting type after applying the |
operator.
fn bitor(self, other: SubmoduleStatus) -> SubmoduleStatus
fn bitor(self, other: SubmoduleStatus) -> SubmoduleStatus
Returns the union of the two sets of flags.
impl BitOrAssign for SubmoduleStatus
impl BitOrAssign for SubmoduleStatus
fn bitor_assign(&mut self, other: SubmoduleStatus)
fn bitor_assign(&mut self, other: SubmoduleStatus)
Adds the set of flags.
impl BitXor for SubmoduleStatus
impl BitXor for SubmoduleStatus
type Output = SubmoduleStatus
The resulting type after applying the ^
operator.
fn bitxor(self, other: SubmoduleStatus) -> SubmoduleStatus
fn bitxor(self, other: SubmoduleStatus) -> SubmoduleStatus
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign for SubmoduleStatus
impl BitXorAssign for SubmoduleStatus
fn bitxor_assign(&mut self, other: SubmoduleStatus)
fn bitxor_assign(&mut self, other: SubmoduleStatus)
Toggles the set of flags.
impl BitAnd for SubmoduleStatus
impl BitAnd for SubmoduleStatus
type Output = SubmoduleStatus
The resulting type after applying the &
operator.
fn bitand(self, other: SubmoduleStatus) -> SubmoduleStatus
fn bitand(self, other: SubmoduleStatus) -> SubmoduleStatus
Returns the intersection between the two sets of flags.
impl BitAndAssign for SubmoduleStatus
impl BitAndAssign for SubmoduleStatus
fn bitand_assign(&mut self, other: SubmoduleStatus)
fn bitand_assign(&mut self, other: SubmoduleStatus)
Disables all flags disabled in the set.
impl Sub for SubmoduleStatus
impl Sub for SubmoduleStatus
type Output = SubmoduleStatus
The resulting type after applying the -
operator.
fn sub(self, other: SubmoduleStatus) -> SubmoduleStatus
fn sub(self, other: SubmoduleStatus) -> SubmoduleStatus
Returns the set difference of the two sets of flags.
impl SubAssign for SubmoduleStatus
impl SubAssign for SubmoduleStatus
fn sub_assign(&mut self, other: SubmoduleStatus)
fn sub_assign(&mut self, other: SubmoduleStatus)
Disables all flags enabled in the set.
impl Not for SubmoduleStatus
impl Not for SubmoduleStatus
type Output = SubmoduleStatus
The resulting type after applying the !
operator.
fn not(self) -> SubmoduleStatus
fn not(self) -> SubmoduleStatus
Returns the complement of this set of flags.
impl Extend<SubmoduleStatus> for SubmoduleStatus
impl Extend<SubmoduleStatus> for SubmoduleStatus
fn extend<T: IntoIterator<Item = SubmoduleStatus>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = SubmoduleStatus>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
impl FromIterator<SubmoduleStatus> for SubmoduleStatus
impl FromIterator<SubmoduleStatus> for SubmoduleStatus
fn from_iter<T: IntoIterator<Item = SubmoduleStatus>>(
iterator: T
) -> SubmoduleStatus
fn from_iter<T: IntoIterator<Item = SubmoduleStatus>>(
iterator: T
) -> SubmoduleStatus
Creates a value from an iterator. Read more
Auto Trait Implementations
impl Send for SubmoduleStatus
impl Send for SubmoduleStatus
impl Sync for SubmoduleStatus
impl Sync for SubmoduleStatus