Struct Upstream 

pub struct Upstream {
    pub reference: String,
    pub commit: String,
    pub behind: usize,
    pub ahead: usize,
}

The remote-tracking ref a resolved base is measured against, and the two reachability counts that say how far apart they are.

Both counts, never one. “Behind by 17” and “behind by 17, ahead by 3” are different situations with different consequences — the first over-reports a change, the second can omit it — and a single number could not tell them apart. See Repo::resolve_base.

Fields

reference: String

Full name of the tracking ref (refs/remotes/origin/main).

commit: String

The commit it points at, in full hex.

behind: usize

Commits the upstream has that the base does not — base..upstream.

ahead: usize

Commits the base has that the upstream does not — upstream..base.

Implementations

impl Upstream

pub fn short_commit(&self) -> &str

The first twelve hex digits of Upstream::commit; see BaseResolution::short_commit.

pub fn is_behind(&self) -> bool

Whether the base is missing commits its upstream has — the diff is then a superset of the true one, which is the silent failure: more files, all of yours included, so nothing fails and the run reads as more thorough.

pub fn diverged(&self) -> bool

Whether the two have genuinely forked. This is the case a clean verdict actively misleads about, because the diff can omit changes present on both sides of the fork.

Trait Implementations

impl Clone for Upstream

fn clone(&self) -> Upstream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Upstream

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

Formats the value using the given formatter.

impl Eq for Upstream

impl PartialEq for Upstream

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Upstream

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 Upstream