Enum git_protocol::fetch::refs::Ref

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

Available on crate features blocking-client or async-client only.

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

Variants

Peeled

Fields

full_ref_name: BString

The name at which the ref is located, like refs/tags/1.0.

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

full_ref_name: BString

The name 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

full_ref_name: BString

The name at which the symbolic ref is located, like HEAD.

target: BString

The path of the ref the symbolic ref points to, like refs/heads/main.

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

Unborn

Fields

full_ref_name: BString

The name at which the ref is located, typically HEAD.

target: BString

The path of the ref the symbolic ref points to, like refs/heads/main, even though the target does not yet exist.

A ref is unborn on the remote and just points to the initial, unborn branch, as is the case in a newly initialized repository or dangling symbolic refs.

Implementations

impl Ref

pub fn unpack(&self) -> (&BStr, Option<&oid>, Option<&oid>)

Provide shared fields referring to the ref itself, namely (name, target, [peeled]). In case of peeled refs, the tag object itself is returned as it is what the ref directly refers to, and target of the tag is returned as peeled. If unborn, the first object id will be the null oid.

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<'de> Deserialize<'de> for Ref

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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,
    Self: Sized,

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) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 Serialize for Ref

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Ref

impl StructuralEq for Ref

impl StructuralPartialEq for Ref