Struct gitcc_convco::ConvcoMessage

pub struct ConvcoMessage {
    pub type: String,
    pub scope: Option<String>,
    pub is_breaking: bool,
    pub desc: String,
    pub body: Option<String>,
    pub footer: Option<IndexMap<String, String>>,
}

Conventional commit message

Fields

type: String

Commit type

scope: Option<String>

Commit scope

is_breaking: bool

Indicates that this is a breaking change (!)

desc: String

Commit description

body: Option<String>

Commit body

footer: Option<IndexMap<String, String>>

Footer

A footer must be a list of key: value pairs following the git trailer convention

Implementations

impl ConvcoMessage

pub fn add_breaking_change(&mut self, desc: &str) -> &mut Self

Sets a breaking change

pub fn add_footer_note(&mut self, key: &str, value: &str) -> &mut Self

Inserts a footer note

pub fn is_breaking_change(&self) -> bool

Checks if the message has a breaking change

Trait Implementations

impl Clone for ConvcoMessage

fn clone(&self) -> ConvcoMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConvcoMessage

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

Formats the value using the given formatter.

impl Default for ConvcoMessage

fn default() -> ConvcoMessage

Returns the “default value” for a type.

impl Display for ConvcoMessage

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

Formats the value using the given formatter.

impl FromStr for ConvcoMessage

type Err = ConvcoError

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.