Struct Reference

pub struct Reference {
    pub name: String,
    pub kind: String,
    pub error: String,
}

A reference in a git repository.

Fields

name: String

The name of the reference, e.g. "refs/heads/my_branch".

kind: String

The kind of reference, e.g. "symbolic" or "direct".

error: String

An error encountered when trying to resolve the reference, or "".

Implementations

impl Reference

pub fn new<N: Display, K: Display>(name: N, kind: K) -> Self

Create a new reference without an error.

pub fn new_with_error<N, K, E>(name: N, kind: K, error: E) -> Self

where N: Display, K: Display, E: Debug,

Create a new reference with an error.

pub fn symbolic<N: Display>(name: N) -> Self

Create a new symbolic reference.

pub fn direct<N: Display>(name: N) -> Self

Create a new direct reference.

pub fn short(&self) -> &str

Get the short name of a reference if it’s a tag or branch. Otherwise, get the full name.

Trait Implementations

impl Debug for Reference

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

Formats the value using the given formatter.

impl Default for Reference

fn default() -> Reference

Returns the “default value” for a type.

impl ShellVars for Reference

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

Write self to the shell writer out.