Struct Message

pub struct Message {
    pub body: Option<String>,
    pub description: Option<String>,
    pub footers: Option<HashMap<String, String>>,
    pub raw: String,
    pub type: Option<String>,
    pub scope: Option<String>,
    pub subject: Option<String>,
}

Message represents a single commit message.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Fields

body: Option<String>

Body part of the commit message.

description: Option<String>

Description part of the commit message.

footers: Option<HashMap<String, String>>

Footers part of the commit message.

raw: String

Raw commit message (or any input from stdin) including the body and footers.

type: Option<String>

Type part of the commit message.

scope: Option<String>

Scope part of the commit message.

subject: Option<String>

Subject part of the commit message.

Implementations

impl Message

Message represents a commit message.

pub fn new(raw: String) -> Self

Create a new Message.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.