Struct mit_commit::Trailer[−][src]

pub struct Trailer { /* fields omitted */ }

Expand description

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

Implementations

[src]

impl Trailer

[src]

pub fn new(key: &str, value: &str) -> Trailer

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", "#124"),
    Trailer::try_from(Body::from("Co-authored-by: #124"))
        .expect("There should have been a trailer in that body component")
)

[src]

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", "#124").get_key(),
    "Co-authored-by"
)

[src]

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", "#124").get_value(), "#124")

Trait Implementations

[src]

impl Clone for Trailer

[src]

fn clone(&self) -> Trailer

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for Trailer

[src]

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

Formats the value using the given formatter. Read more

[src]

impl From<Trailer> for String

[src]

fn from(trailer: Trailer) -> Self

Performs the conversion.

[src]

impl From<Trailer> for Fragment

[src]

fn from(trailer: Trailer) -> Self

Performs the conversion.

[src]

impl Hash for Trailer

[src]

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

Feeds a slice of this type into the given Hasher. Read more

[src]

impl Ord for Trailer

[src]

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

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

Restrict a value to a certain interval. Read more

[src]

impl PartialEq<Trailer> for Trailer

[src]

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

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

1.0.0[src]

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

This method tests for !=.

[src]

impl PartialOrd<Trailer> for Trailer

[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

[src]

impl TryFrom<Body> for Trailer

type Error = Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

impl Eq for Trailer

[src]

impl StructuralEq for Trailer

Auto Trait Implementations

impl RefUnwindSafe for Trailer

impl Send for Trailer

impl Sync for Trailer

impl Unpin for Trailer

impl UnwindSafe for Trailer

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

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

recently added

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

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct mit_commit::Trailer[−][src]

Implementations

impl Trailer

pub fn new(key: &str, value: &str) -> Trailer

Example

pub fn get_key(&self) -> String

Example

pub fn get_value(&self) -> String

Example

Trait Implementations

impl Clone for Trailer

fn clone(&self) -> Trailer

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

impl Debug for Trailer

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

impl From<Trailer> for String

fn from(trailer: Trailer) -> Self

impl From<Trailer> for Fragment

fn from(trailer: Trailer) -> Self

impl Hash for Trailer

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

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

impl Ord for Trailer

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

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

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

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

impl PartialEq<Trailer> for Trailer

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

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

impl PartialOrd<Trailer> for Trailer

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

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

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

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

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

impl TryFrom<Body> for Trailer

type Error = Error

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

impl Eq for Trailer

impl StructuralEq for Trailer

Auto Trait Implementations

impl RefUnwindSafe for Trailer

impl Send for Trailer

impl Sync for Trailer

impl Unpin for Trailer

impl UnwindSafe for Trailer

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

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

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,