Struct RepoSnapshot 

#[non_exhaustive]
pub struct RepoSnapshot {
    pub head: Option<String>,
    pub branch: Option<String>,
    pub tracking: Option<UpstreamTracking>,
    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 a small fixed number of 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). On jj this is the nearest bookmark reachable from @ (heads(::@ & bookmarks())), so it stays set across a jj describe/jj new/jj commit; None when detached / no bookmark on or above @. Matches Repo::current_branch by construction.

tracking: Option<UpstreamTracking>

Upstream tracking and how far the branch is ahead/behind it, as one unit — Some only when an upstream is configured, None otherwise (and always None on jj, which has no git-style upstream tracking). Bundling the three together makes the “all-or-nothing” relationship unrepresentable as a half-populated state. See UpstreamTracking.

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).

Implementations

impl RepoSnapshot

pub fn new() -> Self

A clean snapshot: detached (no head/branch), no upstream tracking, not dirty or conflicted, change count 0, OperationState::Clear. Chain the setters to fill it — for a test double or a custom VcsRepo backend that must return a RepoSnapshot (the struct is #[non_exhaustive], so it can’t be built with a literal outside this crate).

pub fn head(self, head: impl Into<String>) -> Self

Set the working-copy commit’s object id.

pub fn branch(self, branch: impl Into<String>) -> Self

Set the current branch (git) / bookmark (jj).

pub fn tracking(self, tracking: UpstreamTracking) -> Self

Set the upstream tracking (see UpstreamTracking).

pub fn dirty(self, change_count: usize) -> Self

Mark the working copy dirty and record how many paths changed (a real snapshot has change_count >= 1 when dirty — the two fields move together, so this setter couples them). A clean copy is the new default.

pub fn conflicted(self) -> Self

Mark the working copy as having an unresolved conflict.

pub fn operation(self, operation: OperationState) -> Self

Set the in-progress operation / conflict state.

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 Default for RepoSnapshot

fn default() -> Self

Returns the “default value” for a type.

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