Struct ConventionalCommit 

pub struct ConventionalCommit {
    pub type: String,
    pub scope: Option<String>,
    pub description: String,
    pub body: Option<String>,
    pub footers: Vec<Footer>,
    pub is_breaking: bool,
}

A parsed conventional commit message.

Fields

type: String

The commit type (e.g. feat, fix).

scope: Option<String>

The optional scope (e.g. auth).

description: String

The commit description (subject line after type(scope): ).

body: Option<String>

The optional body, separated from the header by a blank line.

footers: Vec<Footer>

Trailer footers.

is_breaking: bool

Whether this is a breaking change (! suffix or BREAKING CHANGE footer).

Trait Implementations

impl Clone for ConventionalCommit

fn clone(&self) -> ConventionalCommit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConventionalCommit

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

Formats the value using the given formatter.

impl PartialEq for ConventionalCommit

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ConventionalCommit

impl StructuralPartialEq for ConventionalCommit