Enum git_protocol::fetch::refs::Ref

pub enum Ref {
    Peeled {
        path: BString,
        tag: ObjectId,
        object: ObjectId,
    },
    Direct {
        path: BString,
        object: ObjectId,
    },
    Symbolic {
        path: BString,
        target: BString,
        object: ObjectId,
    },
}

A git reference, commonly referred to as ‘ref’, as returned by a git server before sending a pack.

Variants

Peeled

Fields

path: BString

The path at which the ref is located, like /refs/heads/main.

tag: ObjectId

The hash of the tag the ref points to.

object: ObjectId

The hash of the object the tag points to.

A ref pointing to a tag object, which in turns points to an object, usually a commit

Direct

Fields

path: BString

The path at which the ref is located, like /refs/heads/main.

object: ObjectId

The hash of the object the ref points to.

A ref pointing to a commit object

Symbolic

Fields

path: BString

The path at which the symbolic ref is located, like /refs/heads/main.

target: BString

The path of the ref the symbolic ref points to, see issue #205 for details

object: ObjectId

The hash of the object the target ref points to.

A symbolic ref pointing to target ref, which in turn points to an object

Implementations

impl Ref

pub fn unpack(&self) -> (&BString, &ObjectId)

Provide shared fields referring to the ref itself, namely (path, object id). In case of peeled refs, the tag object itself is returned as it is what the path refers to.

Trait Implementations

impl Clone for Ref

fn clone(&self) -> Ref

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ref

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

Formats the value using the given formatter.

impl Hash for Ref

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Ref

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Ref> for Ref

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Ref> for Ref

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Ref

impl StructuralEq for Ref

impl StructuralPartialEq for Ref