Struct git2::Signature

source ·
pub struct Signature<'a> { /* private fields */ }
Expand description

A Signature is used to indicate authorship of various actions throughout the library.

Signatures contain a name, email, and timestamp. All fields can be specified with new while the now constructor omits the timestamp. The Repository::signature method can be used to create a default signature with name and email values read from the configuration.

Implementations§

source§

impl<'a> Signature<'a>

source

pub fn now(name: &str, email: &str) -> Result<Signature<'static>, Error>

Create a new action signature with a timestamp of ‘now’.

See new for more information

source

pub fn new( name: &str, email: &str, time: &Time ) -> Result<Signature<'static>, Error>

Create a new action signature.

The time specified is in seconds since the epoch, and the offset is the time zone offset in minutes.

Returns error if either name or email contain angle brackets.

source

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

Gets the name on the signature.

Returns None if the name is not valid utf-8

source

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

Gets the name on the signature as a byte slice.

source

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

Gets the email on the signature.

Returns None if the email is not valid utf-8

source

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

Gets the email on the signature as a byte slice.

source

pub fn when(&self) -> Time

Get the when of this signature.

source

pub fn to_owned(&self) -> Signature<'static>

Convert a signature of any lifetime into an owned signature with a static lifetime.

Trait Implementations§

source§

impl Clone for Signature<'static>

source§

fn clone(&self) -> Signature<'static>

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<'a> Display for Signature<'a>

source§

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

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

impl<'a> Drop for Signature<'a>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl PartialEq for Signature<'_>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Eq for Signature<'_>

Auto Trait Implementations§

§

impl<'a> Freeze for Signature<'a>

§

impl<'a> RefUnwindSafe for Signature<'a>

§

impl<'a> !Send for Signature<'a>

§

impl<'a> !Sync for Signature<'a>

§

impl<'a> Unpin for Signature<'a>

§

impl<'a> UnwindSafe for Signature<'a>

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. 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.