gix-actor 0.40.1

A way to identify git actors
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! This crate provides ways of identifying an actor within the git repository both in shared and mutable variants.
//!
//! ## Examples
//!
//! ```
//! use gix_actor::{IdentityRef, SignatureRef};
//!
//! let actor = IdentityRef::from_bytes::<()>(b" Taylor Example < taylor@example.com >")
//!     .unwrap()
//!     .trim();
//! assert_eq!(actor.name, "Taylor Example");
//! assert_eq!(actor.email, "taylor@example.com");
//!
//! let signature = SignatureRef::from_bytes::<()>(b"Taylor Example <taylor@example.com> 1711398853 +0800")
//!     .unwrap()
//!     .trim();
//! assert_eq!(signature.actor(), actor);
//!
//! let time = signature.time().unwrap();
//! assert_eq!(time.seconds, 1_711_398_853);
//! assert_eq!(time.offset, 8 * 60 * 60);
//!
//! let owned = signature.to_owned().unwrap();
//! let mut out = Vec::new();
//! owned.write_to(&mut out).unwrap();
//! assert_eq!(out, b"Taylor Example <taylor@example.com> 1711398853 +0800");
//! ```
//!
//! ## Feature Flags
#![cfg_attr(
    all(doc, feature = "document-features"),
    doc = ::document_features::document_features!()
)]
#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg))]
#![deny(missing_docs, rust_2018_idioms, unsafe_code)]

/// The re-exported `bstr` crate.
///
/// For convenience to allow using `bstr` without adding it to own cargo manifest.
pub use bstr;
use bstr::{BStr, BString};
/// The re-exported `gix-date` crate.
///
/// For convenience to allow using `gix-date` without adding it to own cargo manifest.
pub use gix_date as date;

mod identity;
///
pub mod signature;

/// A person with name and email.
#[derive(Default, PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Identity {
    /// The actors name, potentially with whitespace as parsed.
    ///
    /// Use [IdentityRef::trim()] or trim manually to be able to clean it up.
    pub name: BString,
    /// The actor's email, potentially with whitespace and garbage as parsed.
    ///
    /// Use [IdentityRef::trim()] or trim manually to be able to clean it up.
    pub email: BString,
}

/// A person with name and email, as reference.
#[derive(Default, PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct IdentityRef<'a> {
    /// The actors name, potentially with whitespace as parsed.
    ///
    /// Use [IdentityRef::trim()] or trim manually to be able to clean it up.
    #[cfg_attr(feature = "serde", serde(borrow))]
    pub name: &'a BStr,
    /// The actor's email, potentially with whitespace and garbage as parsed.
    ///
    /// Use [IdentityRef::trim()] or trim manually to be able to clean it up.
    pub email: &'a BStr,
}

/// A mutable signature that is created by an actor at a certain time.
///
/// Note that this is not a cryptographical signature.
#[derive(Default, PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Signature {
    /// The actors name, potentially with whitespace as parsed.
    ///
    /// Use [SignatureRef::trim()] or trim manually to be able to clean it up.
    pub name: BString,
    /// The actor's email, potentially with whitespace and garbage as parsed.
    ///
    /// Use [SignatureRef::trim()] or trim manually to be able to clean it up.
    pub email: BString,
    /// The time stamp at which the signature is performed.
    pub time: date::Time,
}

/// 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.
#[derive(Default, PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct SignatureRef<'a> {
    /// The actors name, potentially with whitespace as parsed.
    ///
    /// Use [SignatureRef::trim()] or trim manually for cleanup.
    #[cfg_attr(feature = "serde", serde(borrow))]
    pub name: &'a BStr,
    /// The actor's email, potentially with whitespace and garbage as parsed.
    ///
    /// Use [SignatureRef::trim()] or trim manually for cleanup.
    pub email: &'a BStr,
    /// The timestamp at which the signature was performed,
    /// potentially malformed due to lenient parsing.
    ///
    /// Use [`SignatureRef::time()`] to decode.
    pub time: &'a str,
}