Struct SignatureRef 

pub struct SignatureRef<'a> {
    pub name: &'a BStr,
    pub email: &'a BStr,
    pub time: &'a str,
}

An immutable signature that is created by an actor at a certain time.

All of its fields are references to the backing buffer to allow lossless round-tripping, as decoding the time field could be a lossy transformation.

Note that this is not a cryptographical signature.

Fields

name: &'a BStr

The actors name, potentially with whitespace as parsed.

Use SignatureRef::trim() or trim manually for cleanup.

email: &'a BStr

The actor’s email, potentially with whitespace and garbage as parsed.

Use SignatureRef::trim() or trim manually for cleanup.

time: &'a str

The timestamp at which the signature was performed, potentially malformed due to lenient parsing.

Use SignatureRef::time() to decode.

Implementations

impl<'a> SignatureRef<'a>

Lifecycle

pub fn from_bytes<E>(data: &'a [u8]) -> Result<SignatureRef<'a>, ErrMode<E>>

where E: ParserError<&'a [u8]> + AddContext<&'a [u8], StrContext>,

Deserialize a signature from the given data.

pub fn to_owned(&self) -> Result<Signature, Error>

Try to parse the timestamp and create an owned instance from this shared one.

impl<'a> SignatureRef<'a>

Access

pub fn trim(&self) -> SignatureRef<'a>

Trim the whitespace surrounding the name, email and time and return a new signature.

pub fn actor(&self) -> IdentityRef<'a>

Return the actor’s name and email, effectively excluding the timestamp of this signature.

pub fn seconds(&self) -> SecondsSinceUnixEpoch

Parse only the seconds since unix epoch from the time field, or silently default to 0 if parsing fails. Note that this ignores the timezone, so it can parse otherwise broken dates.

For a fallible and more complete, but slower version, use time().

pub fn time(&self) -> Result<Time, Error>

Parse the time field for access to the passed time since unix epoch, and the time offset. The format is expected to be raw.

impl SignatureRef<'_>

pub fn write_to(&self, out: &mut dyn Write) -> Result<()>

Serialize this instance to out in the git serialization format for actors.

pub fn size(&self) -> usize

Computes the number of bytes necessary to serialize this signature

Trait Implementations

impl<'a> Clone for SignatureRef<'a>

fn clone(&self) -> SignatureRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SignatureRef<'a>

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

Formats the value using the given formatter.

impl<'a> Default for SignatureRef<'a>

fn default() -> SignatureRef<'a>

Returns the “default value” for a type.

impl<'de: 'a, 'a> Deserialize<'de> for SignatureRef<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SignatureRef<'_>> for Signature

Note that this conversion is lossy due to the lenient parsing of the time field.

fn from(other: SignatureRef<'_>) -> Signature

Converts to this type from the input type.

impl<'a> From<SignatureRef<'a>> for IdentityRef<'a>

fn from(_: SignatureRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for SignatureRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for SignatureRef<'a>

fn cmp(&self, other: &SignatureRef<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for SignatureRef<'a>

fn eq(&self, other: &SignatureRef<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for SignatureRef<'a>

fn partial_cmp(&self, other: &SignatureRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for SignatureRef<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Copy for SignatureRef<'a>

impl<'a> Eq for SignatureRef<'a>

impl<'a> StructuralPartialEq for SignatureRef<'a>