Struct Tag 

pub struct Tag {
    pub target: ObjectId,
    pub target_kind: Kind,
    pub name: BString,
    pub tagger: Option<Signature>,
    pub message: BString,
    pub signature: Option<BString>,
}

A mutable git tag.

Fields

target: ObjectId

The hash this tag is pointing to.

target_kind: Kind

The kind of object this tag is pointing to.

name: BString

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

tagger: Option<Signature>

The tags author.

message: BString

The message describing the tag.

signature: Option<BString>

Any Git-supported in-body cryptographic signature.

Use signature() to also obtain its detected format.

Implementations

impl Tag

pub fn sign(self, options: Options) -> Result<Tag>

Available on crate feature signature only.

Return this annotated tag with its in-body signature replaced by a newly created one according to options.

Unsuccessful signer exits provide program, exit_status, stdout, stderr, and, when available, exit_code according to the external program runtime failure schema.

impl Tag

pub fn signature(&self) -> Option<SignatureRef<'_>>

Return the in-body cryptographic signature and its detected format.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Self

Returns a duplicate 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<'de> Deserialize<'de> for Tag

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Tag

impl From<Tag> for Object

fn from(v: Tag) -> Self

Converts to this type from the input type.

impl Hash for Tag

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 Tag

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Tag

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Tag

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

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tag

impl TryFrom<Object> for Tag

type Error = Object

The type returned in the event of a conversion error.

fn try_from(value: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TagRef<'_>> for Tag

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl WriteTo for Tag

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

Write a representation of this instance to out.

fn kind(&self) -> Kind

Returns the type of this object.

fn size(&self) -> u64

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