gitbox 2.1.3

Git toolbox to simplify adoption of conventional commits and semantic version, among other things.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

use super::{
    conventional_commit_summary::{
        ConventionalCommitSummary, ConventionalCommitSummaryBreakingFlag,
    },
    error::conventional_commit_error::ConventionalCommitError,
};

/**
A [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/).

Other than a [ConventionalCommitSummary], it also contains the optional message.

This message should contain all the lines but the first,
so no duplicate information is present.
*/
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct ConventionalCommit {
    summary: ConventionalCommitSummary,
    message: Option<String>,
}

impl ConventionalCommit {
    pub fn new(
        typ: String,
        scope: Option<String>,
        breaking: ConventionalCommitSummaryBreakingFlag,
        summary: String,
        message: Option<String>,
    ) -> Result<Self, ConventionalCommitError> {
        Ok(ConventionalCommit {
            summary: ConventionalCommitSummary::new(typ, scope, breaking, summary)?,
            message,
        })
    }

    pub fn summary(&self) -> &ConventionalCommitSummary {
        &self.summary
    }

    pub fn message(&self) -> Option<&str> {
        self.message.as_deref()
    }
}