Struct conventional_commits_parser::Commit

pub struct Commit<'a> {
    pub body: Option<&'a str>,
    pub desc: &'a str,
    pub footer: Vec<Footer<'a>>,
    pub is_breaking_change: bool,
    pub scope: Option<&'a str>,
    pub ty: &'a str,
}

A commit message.

The different sections are separated by an empty newline.

Fields

body: Option<&'a str>

A body.

desc: &'a str

A short summary.

footer: Vec<Footer<'a>>

A list of footers. Empty when none.

is_breaking_change: bool

Set if the commit is a breaking change.

scope: Option<&'a str>

The optional scope of the commit.

ty: &'a str

The type of the commit.

Implementations

impl<'a> Commit<'a>

pub fn new() -> Commit<'a>

pub fn from(
    ty: &'a str,
    scope: Option<&'a str>,
    desc: &'a str,
    body: Option<&'a str>,
    is_breaking_change: bool,
    footer: Vec<Footer<'a>>
) -> Commit<'a>

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<(), Error>

Formats the value using the given formatter.

impl<'a> Default for Commit<'a>

fn default() -> Commit<'a>

Returns the "default value" for a type.

impl<'a> Eq for Commit<'a>

impl<'a> Hash for Commit<'a>

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

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> 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: &Commit<'a>) -> bool

This method tests for !=.