Struct Head

pub struct Head {
    pub trail: Vec<Reference>,
    pub hash: String,
    pub ahead_of_upstream: Option<usize>,
    pub behind_upstream: Option<usize>,
    pub upstream_error: String,
}

The trail of a HEAD reference.

Fields

trail: Vec<Reference>

The trail of references leading to the actual underlying commit.

hash: String

The hash of the commit.

ahead_of_upstream: Option<usize>

How many commits are we ahead of upstream?

None means that there is no upstream, or there is no equivalent branch in upstream.

behind_upstream: Option<usize>

How many commits are we behind upstream?

None means that there is no upstream, or there is no equivalent branch in upstream.

upstream_error: String

An error encountered trying to calculate differences with upstream.

Trait Implementations

impl Debug for Head

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

Formats the value using the given formatter.

impl Default for Head

fn default() -> Head

Returns the “default value” for a type.

impl ShellVars for Head

fn write_to_shell<W: Write>(&self, out: &ShellWriter<W>)

Write self to the shell writer out.