Struct conventional_commits_types::Footer

pub struct Footer<'a> {
    pub token: &'a str,
    pub separator: FooterSeparator,
    pub value: &'a str,
}

A commit message footer.

Fields

token: &'a str

The footer word token.

separator: FooterSeparator

The separator.

value: &'a str

The footer's value.

Implementations

impl<'a> Footer<'a>

pub fn new() -> Self

Creates a default footer.

pub fn from(token: &'a str, separator: FooterSeparator, value: &'a str) -> Self

Creates a footer with the given values.

Trait Implementations

impl<'a> Clone for Footer<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Footer<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Footer<'a>

fn default() -> Footer<'a>

Returns the "default value" for a type.

impl<'a> Eq for Footer<'a>

impl<'a> Hash for Footer<'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> PartialEq<Footer<'a>> for Footer<'a>

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

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

fn ne(&self, other: &Footer<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for Footer<'a>

impl<'a> StructuralPartialEq for Footer<'a>