Struct mit_commit::Trailer

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

A Trailer you might see a in a [CommitMessage], for example ‘Co-authored-by: Billie Thompson billie@example.com’

Implementations

impl<'a> Trailer<'a>

pub const fn new(key: Cow<'a, str>, value: Cow<'a, str>) -> Trailer<'a>

Create a new Trailer

This creates a new element that represents the sort of [Trailers] you get at the end of commits

For example there’s Co-authored-by, Relates-to, and Signed-off-by

Example

use std::convert::TryFrom;

use mit_commit::{Body, Trailer};
assert_eq!(
    Trailer::new("Co-authored-by".into(), "#124".into()),
    Trailer::try_from(Body::from("Co-authored-by: #124"))
        .expect("There should have been a trailer in that body component")
)

pub fn get_key(&self) -> String

Get the key of the Trailer

Example

use std::convert::TryFrom;

use mit_commit::{Body, Trailer};
assert_eq!(
    Trailer::new("Co-authored-by".into(), "#124".into()).get_key(),
    "Co-authored-by"
)

pub fn get_value(&self) -> String

Get the value of the Trailer

Example

use std::convert::TryFrom;

use mit_commit::{Body, Trailer};
assert_eq!(
    Trailer::new("Co-authored-by".into(), "#124".into()).get_value(),
    "#124"
)

Trait Implementations

impl<'a> Clone for Trailer<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Trailer<'a>

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

Formats the value using the given formatter.

impl<'a> From<Trailer<'a>> for Fragment<'a>

fn from(trailer: Trailer<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<Trailer<'a>> for String

fn from(trailer: Trailer<'_>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Trailer<'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,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Trailer<'a>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'a> PartialEq<Trailer<'a>> for Trailer<'a>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd<Trailer<'a>> for Trailer<'a>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> TryFrom<Body<'a>> for Trailer<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(body: Body<'a>) -> Result<Trailer<'a>, Self::Error>

Performs the conversion.

impl<'a> Eq for Trailer<'a>

impl<'a> StructuralEq for Trailer<'a>