[−][src]Struct mit_commit::Trailer

pub struct Trailer { /* fields omitted */ }

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

Implementations

`impl Trailer`[src]

`#[must_use]pub fn new(key: &str, value: &str) -> Trailer`[src]

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 mit_commit::{Body, Trailer};
use std::convert::TryFrom;
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")
)

`#[must_use]pub fn get_key(&self) -> String`[src]

Get the key of the Trailer

Example

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

`#[must_use]pub fn get_value(&self) -> String`[src]

Get the value of the Trailer

Example

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

Trait Implementations

`impl Clone for Trailer`[src]

`fn clone(&self) -> Trailer`[src]

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

`impl Debug for Trailer`[src]

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

`impl Eq for Trailer`[src]

`impl From<Trailer> for String`[src]

`fn from(trailer: Trailer) -> Self`[src]

`impl From<Trailer> for Fragment`[src]

`fn from(trailer: Trailer) -> Self`[src]

`impl Hash for Trailer`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

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

`impl Ord for Trailer`[src]

`fn cmp(&self, other: &Trailer) -> Ordering`[src]

`#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl PartialEq<Trailer> for Trailer`[src]

`fn eq(&self, other: &Self) -> bool`[src]

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl PartialOrd<Trailer> for Trailer`[src]

`fn partial_cmp(&self, other: &Trailer) -> Option<Ordering>`[src]

`fn lt(&self, other: &Trailer) -> bool`[src]

`fn le(&self, other: &Trailer) -> bool`[src]

`fn gt(&self, other: &Trailer) -> bool`[src]

`fn ge(&self, other: &Trailer) -> bool`[src]

`impl StructuralEq for Trailer`[src]

`impl TryFrom<Body> for Trailer`[src]

`type Error = Error`

The type returned in the event of a conversion error.

`fn try_from(body: Body) -> Result<Self, Self::Error>`[src]

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

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

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

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

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

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

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

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

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

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

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

`type Owned = T`

The resulting type after obtaining ownership.

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

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

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

`type Error = Infallible`

The type returned in the event of a conversion error.

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

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

[−][src]Struct mit_commit::Trailer

Implementations

impl Trailer[src]

#[must_use]pub fn new(key: &str, value: &str) -> Trailer[src]

Example

#[must_use]pub fn get_key(&self) -> String[src]

Example

#[must_use]pub fn get_value(&self) -> String[src]

Example

Trait Implementations

impl Clone for Trailer[src]

fn clone(&self) -> Trailer[src]

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

impl Debug for Trailer[src]

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

impl Eq for Trailer[src]

impl From<Trailer> for String[src]

fn from(trailer: Trailer) -> Self[src]

impl From<Trailer> for Fragment[src]

fn from(trailer: Trailer) -> Self[src]

impl Hash for Trailer[src]

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

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

impl Ord for Trailer[src]

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

#[must_use]fn max(self, other: Self) -> Self1.21.0[src]

#[must_use]fn min(self, other: Self) -> Self1.21.0[src]

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[src]

impl PartialEq<Trailer> for Trailer[src]

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

#[must_use]fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl PartialOrd<Trailer> for Trailer[src]

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

fn lt(&self, other: &Trailer) -> bool[src]

fn le(&self, other: &Trailer) -> bool[src]

fn gt(&self, other: &Trailer) -> bool[src]

fn ge(&self, other: &Trailer) -> bool[src]

impl StructuralEq for Trailer[src]

impl TryFrom<Body> for Trailer[src]

type Error = Error

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

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

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

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

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

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

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

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

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

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

fn into(self) -> U[src]

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

type Owned = T

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

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

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

type Error = Infallible

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

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

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

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

`impl Trailer`[src]

`#[must_use]pub fn new(key: &str, value: &str) -> Trailer`[src]

`#[must_use]pub fn get_key(&self) -> String`[src]

`#[must_use]pub fn get_value(&self) -> String`[src]

`impl Clone for Trailer`[src]

`fn clone(&self) -> Trailer`[src]

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

`impl Debug for Trailer`[src]

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

`impl Eq for Trailer`[src]

`impl From<Trailer> for String`[src]

`fn from(trailer: Trailer) -> Self`[src]

`impl From<Trailer> for Fragment`[src]

`fn from(trailer: Trailer) -> Self`[src]

`impl Hash for Trailer`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

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

`impl Ord for Trailer`[src]

`fn cmp(&self, other: &Trailer) -> Ordering`[src]

`#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl PartialEq<Trailer> for Trailer`[src]

`fn eq(&self, other: &Self) -> bool`[src]

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl PartialOrd<Trailer> for Trailer`[src]

`fn partial_cmp(&self, other: &Trailer) -> Option<Ordering>`[src]

`fn lt(&self, other: &Trailer) -> bool`[src]

`fn le(&self, other: &Trailer) -> bool`[src]

`fn gt(&self, other: &Trailer) -> bool`[src]

`fn ge(&self, other: &Trailer) -> bool`[src]

`impl StructuralEq for Trailer`[src]

`impl TryFrom<Body> for Trailer`[src]

`type Error = Error`

`fn try_from(body: Body) -> Result<Self, Self::Error>`[src]

`impl RefUnwindSafe for Trailer`

`impl Send for Trailer`

`impl Sync for Trailer`

`impl Unpin for Trailer`

`impl UnwindSafe for Trailer`

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

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

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

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

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

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

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

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

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

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

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

`type Owned = T`

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

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

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

`type Error = Infallible`

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

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

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

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