Enum GitReference

pub enum GitReference {
    Tag(String),
    Branch(String),
    Rev(String),
    DefaultBranch,
}

Information to find a specific commit in a Git repository.

Variants

Tag(String)

From a tag.

Branch(String)

From a branch.

Rev(String)

From a specific revision. Can be a commit hash (either short or full), or 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_query( query_pairs: impl Iterator<Item = (impl AsRef<str>, impl AsRef<str>)>, ) -> GitReference

pub fn pretty_ref(&self, url_encoded: bool) -> Option<PrettyRef<'_>>

Returns a Displayable view of this git reference, or None if using the head of the default branch

Trait Implementations

impl Clone for GitReference

fn clone(&self) -> GitReference

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl From<GitReference> for Revision

fn from(value: GitReference) -> Self

Converts to this type from the input type.

impl From<Revision> for GitReference

fn from(value: Revision) -> Self

Converts to this type from the input type.

impl Hash for GitReference

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

where __H: Hasher,

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

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes

Size for each variant:

• Tag: 24 bytes
• Branch: 24 bytes
• Rev: 24 bytes
• DefaultBranch: 0 bytes