Enum GitReference 

pub enum GitReference {
    Branch(String),
    Tag(String),
    BranchOrTag(String),
    BranchOrTagOrCommit(String),
    NamedRef(String),
    DefaultBranch,
}

A reference to commit or commit-ish.

Variants

Branch(String)

A specific branch.

Tag(String)

A specific tag.

BranchOrTag(String)

From a reference that’s ambiguously a branch or tag.

BranchOrTagOrCommit(String)

From a reference that’s ambiguously a commit, branch, or tag.

NamedRef(String)

From a named reference, like refs/pull/493/head.

DefaultBranch

The default branch of the repository, the reference named HEAD.

Implementations

impl GitReference

pub fn from_rev(rev: String) -> Self

Creates a GitReference from an arbitrary revision string, which could represent a branch, tag, commit, or named ref.

pub fn as_str(&self) -> Option<&str>

Converts the GitReference to a str.

pub fn as_rev(&self) -> &str

Converts the GitReference to a str that can be used as a revision.

pub fn kind_str(&self) -> &str

Returns the kind of this reference.

Trait Implementations

impl Clone for GitReference

fn clone(&self) -> GitReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitReference

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

Formats the value using the given formatter.

impl Display for GitReference

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

Formats the value using the given formatter.

impl Hash for GitReference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GitReference

fn cmp(&self, other: &GitReference) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GitReference

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

fn partial_cmp(&self, other: &GitReference) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for GitReference

impl StructuralPartialEq for GitReference