Struct git_conventional::Commit [−][src]
pub struct Commit<'a> { /* fields omitted */ }
Expand description
A conventional commit.
Implementations
Create a new Conventional Commit based on the provided commit message string.
Errors
This function returns an error if the commit does not conform to the Conventional Commit specification.
The commit description.
The commit body, containing a more detailed explanation of the commit changes.
A flag to signal that the commit contains breaking changes.
This flag is set either when the commit has an exclamation mark after the message type and scope, e.g.:
feat(scope)!: this is a breaking change
Or when the BREAKING CHANGE:
footer is defined:
feat: my commit description
BREAKING CHANGE: this is a breaking change
Explanation for the breaking change.
Note: if no BREAKING CHANGE
footer is provided, the description
is expected to describe
the breaking change.
Any footer.
A footer is similar to a Git trailer, with the exception of not requiring whitespace before newlines.
Trait Implementations
Auto Trait Implementations
impl<'a> RefUnwindSafe for Commit<'a>
impl<'a> UnwindSafe for Commit<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more