Struct git_conventional::FooterToken

pub struct FooterToken<'a>(_);

A component of the conventional commit.

Methods

impl<'a> FooterToken<'a>

pub const fn new_unchecked(value: &'a str) -> Self

See parse for ensuring the data is valid.

pub fn as_str(&self) -> &'a str

Access str representation

impl<'a> FooterToken<'a>

pub fn parse(sep: &'a str) -> Result<Self, Error>

Parse a str into a FooterToken.

pub fn breaking(&self) -> bool

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

Trait Implementations

impl<'a> Clone for FooterToken<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for FooterToken<'a>

impl<'a> Debug for FooterToken<'a>

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

Formats the value using the given formatter.

impl<'_> Deref for FooterToken<'_>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'_> Display for FooterToken<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for FooterToken<'a>

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

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<'_, '_> PartialEq<&'_ str> for FooterToken<'_>

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

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

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

This method tests for !=.

impl<'a> PartialEq<FooterToken<'a>> for FooterToken<'a>

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

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

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

This method tests for !=.

impl<'a> PartialOrd<FooterToken<'a>> for FooterToken<'a>

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

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

fn lt(&self, other: &FooterToken<'a>) -> bool

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

fn le(&self, other: &FooterToken<'a>) -> bool

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

fn gt(&self, other: &FooterToken<'a>) -> bool

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

fn ge(&self, other: &FooterToken<'a>) -> bool

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

impl<'a> StructuralEq for FooterToken<'a>

impl<'a> StructuralPartialEq for FooterToken<'a>