[go: up one dir, main page]

Struct git2::Signature[−][src]

pub struct Signature<'a> { /* fields omitted */ }
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

impl<'a> Signature<'a>[src]

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

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>[src]

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>[src]

Gets the name on the signature.

Returns None if the name is not valid utf-8

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

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

Gets the name on the signature as a byte slice.

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

Gets the email on the signature.

Returns None if the email is not valid utf-8

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

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

Gets the email on the signature as a byte slice.

pub fn when(&self) -> Time[src]

Get the when of this signature.

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

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

Trait Implementations

impl Clone for Signature<'static>[src]

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

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'a> Display for Signature<'a>[src]

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

Formats the value using the given formatter. Read more

impl<'a> Drop for Signature<'a>[src]

fn drop(&mut self)[src]

Executes the destructor for this type. Read more

Auto Trait Implementations

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

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.