Struct git2::Signature

pub struct Signature<'a> { /* fields omitted */ }

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.

Methods

impl<'a> Signature<'a>

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

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.

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

Gets the name on the signature.

Returns None if the name is not valid utf-8

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

Gets the name on the signature as a byte slice.

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

Gets the email on the signature.

Returns None if the email is not valid utf-8

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

Gets the email on the signature as a byte slice.

pub fn when(&self) -> Time

Get the when of this signature.

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

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

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Signature<'static>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Display for Signature<'a>

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

Formats the value using the given formatter.