Struct UpstreamTracking 

#[non_exhaustive]
pub struct UpstreamTracking {
    pub branch: String,
    pub ahead: Option<usize>,
    pub behind: Option<usize>,
}

Upstream tracking for the current branch: the upstream ref and how far the branch is ahead/behind it. RepoSnapshot carries it as one Option<UpstreamTracking> — None when no upstream is configured at all.

The ahead/behind counts are themselves Option: git reports them only when the upstream ref actually resolves, so a branch whose upstream is set but gone (deleted on the remote, or not yet fetched) yields Some(UpstreamTracking { branch, ahead: None, behind: None }) — “tracking configured but uncountable”, distinct from the in-sync Some(0)/Some(0) that a unwrap_or(0) used to fabricate (M17).

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.

branch: String

The upstream tracking branch, e.g. "origin/main".

ahead: Option<usize>

Commits the local branch is ahead of the upstream; None when the upstream is set but git couldn’t count against it (gone remote / not fetched).

behind: Option<usize>

Commits the local branch is behind the upstream; None when uncountable (see ahead).

Implementations

impl UpstreamTracking

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

Tracking branch (e.g. "origin/main") with uncounted ahead/behind (both None); chain ahead / behind to set the counts.

pub fn ahead(self, n: usize) -> Self

Set the ahead count.

pub fn behind(self, n: usize) -> Self

Set the behind count.

Trait Implementations

impl Clone for UpstreamTracking

fn clone(&self) -> UpstreamTracking

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpstreamTracking

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

Formats the value using the given formatter.

impl Eq for UpstreamTracking

impl PartialEq for UpstreamTracking

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

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 UpstreamTracking