Enum Tag

pub enum Tag {
    Light {
        id: Oid,
        name: RefString,
    },
    Annotated {
        id: Oid,
        target: Oid,
        name: RefString,
        tagger: Option<Author>,
        message: Option<String>,
    },
}

The metadata of a Git tag.

Variants

Light

A light-weight git tag.

Fields

id: Oid

The Object ID for the Tag, i.e the SHA1 digest.

name: RefString

The reference name for this Tag.

Annotated

An annotated git tag.

Fields

id: Oid

The Object ID for the Tag, i.e the SHA1 digest.

target: Oid

The Object ID for the object that is tagged.

name: RefString

The reference name for this Tag.

tagger: Option<Author>

The named author of this Tag, if the Tag was annotated.

message: Option<String>

The message with this Tag, if the Tag was annotated.

Implementations

impl Tag

pub fn id(&self) -> Oid

Get the Oid of the tag, regardless of its type.

pub fn short_name(&self) -> &RefString

Return the short Tag refname, e.g. release/v1.

pub fn refname(&self) -> Qualified<'_>

Return the fully qualified Tag refname, e.g. refs/tags/release/v1.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Ord for Tag

fn cmp(&self, other: &Tag) -> 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 Tag

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

fn partial_cmp(&self, other: &Tag) -> 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 Revision for Tag

type Error = Infallible

fn object_id(&self, _repo: &Repository) -> Result<Oid, Self::Error>

Returns the object id of this revision in repo.

impl TryFrom<&Reference<'_>> for Tag

type Error = FromReference

The type returned in the event of a conversion error.

fn try_from(reference: &Reference<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Tag<'_>> for Tag

type Error = FromTag

The type returned in the event of a conversion error.

fn try_from(tag: &Tag<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Tag

impl StructuralPartialEq for Tag