Struct Signature 

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

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

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) -> Result<&str, Error>

Gets the name on the signature.

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

Gets the name on the signature as a byte slice.

pub fn email(&self) -> Result<&str, Error>

Gets the email on the signature.

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

type Raw = *mut git_signature

The raw type that allows you to interact with libgit2-sys.

unsafe fn from_raw(raw: *mut git_signature) -> Signature<'a>

Build a git2 struct from its Binding::Raw value.

fn raw(&self) -> *mut git_signature

Access the Binding::Raw value for a struct.

unsafe fn from_raw_opt<T>(raw: T) -> Option<Self>

where T: Copy + IsNull, Self: Binding<Raw = T>,

A null-handling version of Binding::from_raw.

impl Clone for Signature<'static>

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

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Signature<'_>

impl PartialEq for Signature<'_>

fn eq(&self, other: &Signature<'_>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl TryFrom<&Author> for Signature<'_>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( person: &Author, ) -> Result<Signature<'_>, <Signature<'_> as TryFrom<&Author>>::Error>

Performs the conversion.