Struct Commit 

pub(crate) struct Commit {
    pub(crate) kind: Option<CommitType>,
    pub(crate) description: String,
    pub(crate) breaking: bool,
}

One commit since the baseline of a unit.

Fields

kind: Option<CommitType>

The type, or None when the subject is not a Conventional Commit.

description: String

The description, or the whole subject when it does not parse.

breaking: bool

Whether the commit marks a breaking change.

Implementations

impl Commit

pub(crate) fn from_messages<'a>( messages: impl IntoIterator<Item = &'a str>, template: &CommitSubject, ) -> Vec<Self>

Read commit messages, skipping the ones whose subject matches the proposal template.

pub(crate) fn parse(message: &str) -> Self

Read one commit message. A body line starting with BREAKING CHANGE: or BREAKING-CHANGE: marks a breaking change too.

fn subject(message: &str) -> &str

The first line of a commit message.

pub(crate) const fn is_release_worthy(&self) -> bool

Whether this commit is a feature, a fix or a breaking change.

pub(crate) const fn bump(&self) -> Bump

The bump this commit asks for.

Trait Implementations

impl Clone for Commit

fn clone(&self) -> Commit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Commit

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

Formats the value using the given formatter.

impl Eq for Commit

impl PartialEq for Commit

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Commit