[−][src]Trait conventional::commit::simple::Simple

pub trait Simple {
    fn type_(&self) -> &str;

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

    fn description(&self) -> &str;

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

    fn breaking(&self) -> bool;

    fn trailers(&self) -> Vec<SimpleTrailer>;
}

The weakly-typed variant of a commit.

Required methods

fn type_(&self) -> &str

The type of the commit.

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

The optional scope of the commit.

fn description(&self) -> &str

The commit description.

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

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

fn breaking(&self) -> bool

A flag to signal that the commit contains breaking changes.

This flag is set either when the commit has an exclamation mark after the message type and scope, e.g.:

feat(scope)!: this is a breaking change feat!: this is a breaking change

Or when the BREAKING CHANGE: trailer is defined:

feat: my commit description

BREAKING CHANGE: this is a breaking change

fn trailers(&self) -> Vec<SimpleTrailer>

Any Git trailers.

See: https://git-scm.com/docs/git-interpret-trailers

Loading content...

Implementors

impl<'_> Simple for Commit<'_>[src]

Loading content...