Struct SubmoduleStatus 

#[non_exhaustive]
pub struct SubmoduleStatus {
    pub path: PathBuf,
    pub sha: String,
    pub state: SubmoduleState,
    pub describe: Option<String>,
}

One entry from git submodule status: the checked-out commit, the mount path, and the sync state derived from the line’s leading prefix character.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: PathBuf

The repo-relative mount path of the submodule. A PathBuf built from the raw bytes (via vcs_diff::path_from_bytes), lossless on Unix.

sha: String

The submodule commit git submodule status reports: the checked-out commit when initialized, or the commit the superproject records (the gitlink) when uninitialized. Full object id (40-hex SHA-1 or 64-hex SHA-256).

state: SubmoduleState

The sync state from the line’s prefix character.

describe: Option<String>

The trailing git describe of the submodule HEAD (the (…) suffix) — e.g. heads/main, a tag, or an abbreviated sha; None for an uninitialized submodule, which has no such suffix.

Trait Implementations

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

Formats the value using the given formatter.

impl Eq for SubmoduleStatus

impl PartialEq for SubmoduleStatus

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SubmoduleStatus