Struct Commit

pub struct Commit<'a> {

    pub id: String,
    pub message: String,
    pub conv: Option<Commit<'a>>,
    pub group: Option<String>,
    pub default_scope: Option<String>,
    pub scope: Option<String>,
    pub links: Vec<Link>,
    pub author: Signature,
    pub committer: Signature,
    pub merge_commit: bool,
    pub extra: Option<Value>,
    pub remote: Option<RemoteContributor>,
    pub github: RemoteContributor,
    pub gitlab: RemoteContributor,
    pub gitea: RemoteContributor,
    pub bitbucket: RemoteContributor,
    pub raw_message: Option<String>,
}

Common commit object that is parsed from a repository.

Fields

id: String

Commit ID.

message: String

Commit message including title, description and summary.

conv: Option<Commit<'a>>

Conventional commit.

group: Option<String>

Commit group based on a commit parser or its conventional type.

default_scope: Option<String>

Default commit scope based on (inherited from) conventional type or a commit parser.

scope: Option<String>

Commit scope for overriding the default one.

links: Vec<Link>

A list of links found in the commit

author: Signature

Commit author.

committer: Signature

Committer.

merge_commit: bool

Whether if the commit has two or more parents.

extra: Option<Value>

Arbitrary data to be used with the --from-context CLI option.

remote: Option<RemoteContributor>

Remote metadata of the commit.

github: RemoteContributor

👎Deprecated: Use remote field instead

Available on crate feature github only.

GitHub metadata of the commit.

gitlab: RemoteContributor

👎Deprecated: Use remote field instead

Available on crate feature gitlab only.

GitLab metadata of the commit.

gitea: RemoteContributor

👎Deprecated: Use remote field instead

Available on crate feature gitea only.

Gitea metadata of the commit.

bitbucket: RemoteContributor

👎Deprecated: Use remote field instead

Available on crate feature bitbucket only.

Bitbucket metadata of the commit.

raw_message: Option<String>

Raw message of the normal commit, works as a placeholder for converting normal commit into conventional commit.

Despite the name, it is not actually a raw message. In fact, it is pre-processed by Commit::preprocess, and only be generated when serializing into context the first time.

Implementations

impl Commit<'_>

pub fn new(id: String, message: String) -> Self

Constructs a new instance.

pub fn raw_message(&self) -> &str

Get raw message for converting into conventional commit.

pub fn process(&self, config: &GitConfig) -> Result<Self>

Processes the commit.

• converts commit to a conventional commit
• sets the group for the commit
• extracts links and generates URLs

pub fn into_conventional(self) -> Result<Self>

Returns the commit with its conventional type set.

pub fn preprocess(self, preprocessors: &[TextProcessor]) -> Result<Self>

Preprocesses the commit using TextProcessors.

Modifies the commit message using regex or custom OS command.

pub fn parse( self, parsers: &[CommitParser], protect_breaking: bool, filter: bool, ) -> Result<Self>

Parses the commit using CommitParsers.

Sets the group and scope of the commit.

pub fn parse_links(self, parsers: &[LinkParser]) -> Result<Self>

Parses the commit using LinkParsers.

Sets the links of the commit.

Trait Implementations

impl<'a> Clone for Commit<'a>

fn clone(&self) -> Commit<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Commit<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Commit<'a>

fn default() -> Commit<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for Commit<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Commit<'_>> for Commit<'_>

Available on crate feature repo only.

fn from(commit: &GitCommit<'_>) -> Self

Converts to this type from the input type.

impl From<String> for Commit<'_>

fn from(message: String) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Commit<'a>

fn eq(&self, other: &Commit<'a>) -> 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 Commit<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Commit<'a>