Struct git_conventional::Commit

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

A conventional commit.

Implementations

impl<'a> Commit<'a>

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

Create a new Conventional Commit based on the provided commit message string.

Errors

This function returns an error if the commit does not conform to the Conventional Commit specification.

pub fn type_(&self) -> Type<'a>

The type of the commit.

pub fn scope(&self) -> Option<Scope<'a>>

The optional scope of the commit.

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

The commit description.

pub fn body(&self) -> Option<&'a str>

The commit body, containing a more detailed explanation of the commit changes.

pub fn breaking(&self) -> bool

A flag to signal that the commit contains breaking changes.

This flag is set either when the commit has an exclamation mark after the message type and scope, e.g.:

feat(scope)!: this is a breaking change

Or when the BREAKING CHANGE: footer is defined:

feat: my commit description

BREAKING CHANGE: this is a breaking change

pub fn breaking_description(&self) -> Option<&'a str>

Explanation for the breaking change.

Note: if no BREAKING CHANGE footer is provided, the description is expected to describe the breaking change.

pub fn footers(&self) -> &[Footer<'a>]

Any 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

Trait Implementations

impl<'a> Clone for Commit<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Commit<'a>

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

Formats the value using the given formatter.

impl Display for Commit<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Commit<'a>> for Commit<'a>

fn eq(&self, other: &Commit<'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> StructuralPartialEq for Commit<'a>