Struct CommitMessage 

pub struct CommitMessage {
    pub header: CommitHeader,
    pub body: String,
    pub trailers: Vec<CommitTrailer>,
}

A commit message taken apart: header, body, trailers.

use majordomus_cli::commit::CommitMessage;
let m = CommitMessage::parse("feat(a): a thing\n\nThe body.\n\nRefs: I1305\n");
assert_eq!(m.header.subject, "a thing");
assert_eq!(m.body, "The body.");
assert_eq!(m.trailers.len(), 1);

Fields

header: CommitHeader

The first line, parsed.

body: String

Everything between the header and the trailer block, with surrounding blank lines removed. Empty when the message is a subject alone.

trailers: Vec<CommitTrailer>

The Key: value lines of the final paragraph, in the order they were written.

Implementations

impl CommitMessage

pub fn parse(text: &str) -> CommitMessage

Read a whole commit message. Total, like CommitHeader::parse: what cannot be read as a header or a trailer is body, and nothing is an error.

use majordomus_cli::commit::CommitMessage;
// a last paragraph of prose is body, not trailers, even though git would disagree
let m = CommitMessage::parse("fix(x): a thing\n\nThe reason: it was wrong.");
assert!(m.trailers.is_empty());
assert_eq!(m.body, "The reason: it was wrong.");

pub fn trailer(&self, key: &str) -> Option<&str>

The value of the first trailer with this key, compared case-insensitively.

use majordomus_cli::commit::CommitMessage;
let m = CommitMessage::parse("fix(x): a\n\nb\n\nCo-Authored-By: Someone <s@example.org>\n");
assert_eq!(m.trailer("co-authored-by"), Some("Someone <s@example.org>"));
assert_eq!(m.trailer("Refs"), None);

pub fn breaking(&self) -> bool

Whether this commit declares itself breaking, by either spelling: the ! in the header or the trailer in the message.

use majordomus_cli::commit::CommitMessage;
assert!(CommitMessage::parse("feat(api)!: the route moved").breaking());
assert!(CommitMessage::parse("feat(api): moved\n\nBREAKING CHANGE: it moved").breaking());
assert!(!CommitMessage::parse("feat(api): moved").breaking());

pub fn render(&self) -> String

Render the message as git will store it: header, blank line, body, blank line, trailers, one final newline.

use majordomus_cli::commit::CommitMessage;
let text = "feat(a)!: a thing\n\nWhy.\n\nRefs: I1305\n";
assert_eq!(CommitMessage::parse(text).render(), text);

Trait Implementations

impl Clone for CommitMessage

fn clone(&self) -> CommitMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommitMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommitMessage

impl JsonSchema for CommitMessage

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CommitMessage

fn eq(&self, other: &CommitMessage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommitMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommitMessage