Struct git2::Tag

pub struct Tag<'repo> { /* private fields */ }

A structure to represent a git tag

Implementations

impl<'repo> Tag<'repo>

pub fn is_valid_name(tag_name: &str) -> bool

Determine whether a tag name is valid, meaning that (when prefixed with refs/tags/) that it is a valid reference name, and that any additional tag name restrictions are imposed (eg, it cannot start with a -).

pub fn id(&self) -> Oid

Get the id (SHA1) of a repository tag

pub fn message(&self) -> Option<&str>

Get the message of a tag

Returns None if there is no message or if it is not valid utf8

pub fn message_bytes(&self) -> Option<&[u8]>

Get the message of a tag

Returns None if there is no message

pub fn name(&self) -> Option<&str>

Get the name of a tag

Returns None if it is not valid utf8

pub fn name_bytes(&self) -> &[u8]

Get the name of a tag

pub fn peel(&self) -> Result<Object<'repo>, Error>

Recursively peel a tag until a non tag git_object is found

pub fn tagger(&self) -> Option<Signature<'_>>

Get the tagger (author) of a tag

If the author is unspecified, then None is returned.

pub fn target(&self) -> Result<Object<'repo>, Error>

Get the tagged object of a tag

This method performs a repository lookup for the given object and returns it

pub fn target_id(&self) -> Oid

Get the OID of the tagged object of a tag

pub fn target_type(&self) -> Option<ObjectType>

Get the ObjectType of the tagged object of a tag

pub fn as_object(&self) -> &Object<'repo>

Casts this Tag to be usable as an Object

pub fn into_object(self) -> Object<'repo>

Consumes Tag to be returned as an Object

Trait Implementations

impl<'repo> Clone for Tag<'repo>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'repo> Debug for Tag<'repo>

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

Formats the value using the given formatter.

impl<'repo> Drop for Tag<'repo>

fn drop(&mut self)

Executes the destructor for this type.