Struct git_conventional::Footer

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

A single footer.

A footer is similar to a Git trailer, with the exception of not requiring whitespace before newlines.

See: https://git-scm.com/docs/git-interpret-trailers

Implementations

impl<'a> Footer<'a>

pub const fn new(
    token: FooterToken<'a>,
    sep: FooterSeparator,
    value: &'a str
) -> Self

Piece together a footer.

pub const fn token(&self) -> FooterToken<'a>

The token of the footer.

pub const fn separator(&self) -> FooterSeparator

The separator between the footer token and its value.

pub const fn value(&self) -> &'a str

The value of the footer.

pub fn breaking(&self) -> bool

A flag to signal that the footer describes a breaking change.

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> 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,
    Self: Sized,

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: &Rhs) -> bool

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

impl<'a> Copy for Footer<'a>

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

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

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