Struct conventional_commit::ConventionalCommit

pub struct ConventionalCommit { /* fields omitted */ }

A conventional commit.

Methods

impl ConventionalCommit

pub fn type_(&self) -> &str

The type of the commit.

pub fn scope(&self) -> Option<&str>

The optional scope of the commit.

pub fn description(&self) -> &str

The commit description.

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

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

pub fn breaking_change(&self) -> Option<&str>

The text discussing any breaking changes.

Trait Implementations

impl Display for ConventionalCommit

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

Formats the value using the given formatter.

impl Debug for ConventionalCommit

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

Formats the value using the given formatter.

impl FromStr for ConventionalCommit

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.