Struct git_object::TagRef

pub struct TagRef<'a> {
    pub target: &'a BStr,
    pub target_kind: Kind,
    pub name: &'a BStr,
    pub tagger: Option<SignatureRef<'a>>,
    pub message: &'a BStr,
    pub pgp_signature: Option<&'a BStr>,
}

Represents a git tag, commonly indicating a software release.

Fields

target: &'a BStr

The hash in hexadecimal being the object this tag points to. Use target() to obtain a byte representation.

target_kind: Kind

The kind of object that target points to.

name: &'a BStr

The name of the tag, e.g. “v1.0”.

tagger: Option<SignatureRef<'a>>

The author of the tag.

message: &'a BStr

The message describing this release.

pgp_signature: Option<&'a BStr>

A cryptographic signature over the entire content of the serialized tag object thus far.

Implementations

impl<'a> TagRef<'a>

pub fn from_bytes(data: &'a [u8]) -> Result<TagRef<'a>, Error>

Deserialize a tag from data.

Examples found in repository

src/commit/mod.rs (line 112)

    pub fn mergetags(self) -> impl Iterator<Item = Result<TagRef<'a>, crate::decode::Error>> {
        self.find_all("mergetag").map(|b| TagRef::from_bytes(b))
    }

src/object/mod.rs (line 210)

    pub fn from_bytes(kind: Kind, data: &'a [u8]) -> Result<ObjectRef<'a>, crate::decode::Error> {
        Ok(match kind {
            Kind::Tree => ObjectRef::Tree(TreeRef::from_bytes(data)?),
            Kind::Blob => ObjectRef::Blob(BlobRef { data }),
            Kind::Commit => ObjectRef::Commit(CommitRef::from_bytes(data)?),
            Kind::Tag => ObjectRef::Tag(TagRef::from_bytes(data)?),
        })
    }

src/data.rs (line 20)

    pub fn decode(&self) -> Result<ObjectRef<'a>, crate::decode::Error> {
        Ok(match self.kind {
            Kind::Tree => ObjectRef::Tree(TreeRef::from_bytes(self.data)?),
            Kind::Blob => ObjectRef::Blob(BlobRef { data: self.data }),
            Kind::Commit => ObjectRef::Commit(CommitRef::from_bytes(self.data)?),
            Kind::Tag => ObjectRef::Tag(TagRef::from_bytes(self.data)?),
        })
    }

pub fn target(&self) -> ObjectId

The object this tag points to as Id.

Examples found in repository

src/tag/write.rs (line 86)

    fn size(&self) -> usize {
        b"object".len() + 1 /* space */ + self.target().kind().len_in_hex() + 1 /* nl */
            + b"type".len() + 1 /* space */ + self.target_kind.as_bytes().len() + 1 /* nl */
            + b"tag".len() + 1 /* space */ + self.name.len() + 1 /* nl */
            + self
                .tagger
                .as_ref()
                .map(|t| b"tagger".len() + 1 /* space */ + t.size() + 1 /* nl */)
                .unwrap_or(0)
            + 1 /* nl */ + self.message.len()
            + self.pgp_signature.as_ref().map(|m| 1 /* nl */ + m.len()).unwrap_or(0)
    }

Trait Implementations

impl<'a> Clone for TagRef<'a>

fn clone(&self) -> TagRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TagRef<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for TagRef<'a>

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

Deserialize this value from the given Serde deserializer.

impl From<TagRef<'_>> for Tag

fn from(other: TagRef<'_>) -> Tag

Converts to this type from the input type.

impl<'a> From<TagRef<'a>> for ObjectRef<'a>

fn from(v: TagRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for TagRef<'a>

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<'a> Ord for TagRef<'a>

fn cmp(&self, other: &TagRef<'a>) -> 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<'a> PartialEq<TagRef<'a>> for TagRef<'a>

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

fn partial_cmp(&self, other: &TagRef<'a>) -> 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<'a> Serialize for TagRef<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<ObjectRef<'a>> for TagRef<'a>

type Error = ObjectRef<'a>

The type returned in the event of a conversion error.

fn try_from(value: ObjectRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> WriteTo for TagRef<'a>

fn write_to(&self, out: impl Write) -> Result<()>

Write a representation of this instance to out.

fn kind(&self) -> Kind

Returns the type of this object.

fn size(&self) -> usize

Returns the size of this object’s representation (the amount of data which would be written by write_to).

fn loose_header(&self) -> SmallVec<[u8; 28]>

Returns a loose object header based on the object’s data

impl<'a> Eq for TagRef<'a>

impl<'a> StructuralEq for TagRef<'a>

impl<'a> StructuralPartialEq for TagRef<'a>