Struct BranchStatus 

#[non_exhaustive]
pub struct BranchStatus {
    pub head: Option<String>,
    pub branch: Option<String>,
    pub upstream: Option<String>,
    pub ahead: Option<usize>,
    pub behind: Option<usize>,
    pub tracked_changes: usize,
    pub untracked: usize,
    pub conflicts: usize,
}

A combined branch + working-tree snapshot from git status --porcelain=v2 --branch -z: HEAD, branch, upstream tracking, ahead/behind, and change counts — everything a prompt/status-bar needs, in one process spawn.

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.

head: Option<String>

The HEAD commit’s full object id (# branch.oid); None on an unborn repo (git reports (initial)). Truncate for display.

branch: Option<String>

Current branch name (# branch.head); None when detached.

upstream: Option<String>

Upstream tracking branch (# branch.upstream); None when unset.

ahead: Option<usize>

Commits ahead of the upstream (# branch.ab +A); None when no upstream.

behind: Option<usize>

Commits behind the upstream (# branch.ab -B); None when no upstream.

tracked_changes: usize

Count of changed tracked entries — modified/added/deleted/renamed/copied and unmerged (the 1/2/u records).

untracked: usize

Count of untracked files (the ? records).

conflicts: usize

Count of unmerged (conflicted) entries (the u records; also in tracked_changes).

Implementations

impl BranchStatus

pub fn is_dirty(&self) -> bool

Whether the working tree has any change at all — tracked or untracked.

Trait Implementations

impl Clone for BranchStatus

fn clone(&self) -> BranchStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BranchStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BranchStatus

fn default() -> BranchStatus

Returns the “default value” for a type.

impl Eq for BranchStatus

impl PartialEq for BranchStatus

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BranchStatus