Struct conventional_commit_parser::commit::ConventionalCommit

pub struct ConventionalCommit {
    pub commit_type: CommitType,
    pub scope: Option<String>,
    pub summary: String,
    pub body: Option<String>,
    pub footers: Vec<Footer>,
    pub is_breaking_change: bool,
}

A conventional commit compliant commit message produced by the parse function

Fields

commit_type: CommitType

The commit type, fix, feat etc.

scope: Option<String>

An optional scope

summary: String

Commit description summary

body: Option<String>

An optional commit body

footers: Vec<Footer>

A list of commit footers

is_breaking_change: bool

A commit that has a footer BREAKING CHANGE or a ! after the commit type and scope

Trait Implementations

impl Debug for ConventionalCommit

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

Formats the value using the given formatter.

impl Default for ConventionalCommit

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<ConventionalCommit> for ConventionalCommit

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

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

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

This method tests for !=.

impl Eq for ConventionalCommit

impl StructuralEq for ConventionalCommit

impl StructuralPartialEq for ConventionalCommit