Struct git2::Tag

source ·
pub struct Tag<'repo> { /* private fields */ }
Expand description

A structure to represent a git tag

Implementations§

source§

impl<'repo> Tag<'repo>

source

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 -).

source

pub fn id(&self) -> Oid

Get the id (SHA1) of a repository tag

source

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

source

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

Get the message of a tag

Returns None if there is no message

source

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

Get the name of a tag

Returns None if it is not valid utf8

source

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

Get the name of a tag

source

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

Recursively peel a tag until a non tag git_object is found

source

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

Get the tagger (author) of a tag

If the author is unspecified, then None is returned.

source

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

source

pub fn target_id(&self) -> Oid

Get the OID of the tagged object of a tag

source

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

Get the ObjectType of the tagged object of a tag

source

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

Casts this Tag to be usable as an Object

source

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

Consumes Tag to be returned as an Object

Trait Implementations§

source§

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

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'repo> RefUnwindSafe for Tag<'repo>

§

impl<'repo> !Send for Tag<'repo>

§

impl<'repo> !Sync for Tag<'repo>

§

impl<'repo> Unpin for Tag<'repo>

§

impl<'repo> UnwindSafe for Tag<'repo>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.