Struct RepoSnapshot 

#[non_exhaustive]
pub struct RepoSnapshot {
    pub head: Option<String>,
    pub branch: Option<String>,
    pub upstream: Option<String>,
    pub ahead: Option<usize>,
    pub behind: Option<usize>,
    pub dirty: bool,
    pub change_count: usize,
    pub conflicted: bool,
    pub operation: OperationState,
}

A one-shot snapshot of the common repository state — branch, upstream tracking, ahead/behind, dirtiness, and operation state — gathered in one or two process spawns instead of a call per field. The data a prompt, status line, or TUI refresh needs. See Repo::snapshot.

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 working-copy commit’s full object id (git HEAD oid / jj @ commit id) on both backends; None on an unborn git repo. Truncate for display.

branch: Option<String>

Current branch (git) / bookmark (jj); None when detached or unset.

upstream: Option<String>

Upstream tracking branch; None when unset, and always None on jj (jj has no git-style upstream tracking).

ahead: Option<usize>

Commits ahead of the upstream; None with no upstream (always on jj).

behind: Option<usize>

Commits behind the upstream; None with no upstream (always on jj).

dirty: bool

Whether the working copy has any uncommitted change (tracked or untracked).

change_count: usize

Number of changed paths (tracked + untracked on git; the @ change’s files on jj).

conflicted: bool

Whether the working copy has an unresolved conflict.

operation: OperationState

In-progress operation / conflict state (see OperationState).

Trait Implementations

impl Clone for RepoSnapshot

fn clone(&self) -> RepoSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RepoSnapshot

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

Formats the value using the given formatter.

impl Eq for RepoSnapshot

impl PartialEq for RepoSnapshot

fn eq(&self, other: &RepoSnapshot) -> 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 Serialize for RepoSnapshot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RepoSnapshot