Enum CommitMessageError 

pub enum CommitMessageError {
    FirstLineTooLong {
        actual: usize,
        max: usize,
    },
    InvalidConventionalFormat {
        reason: String,
    },
}

Errors that can occur when creating a ConventionalCommit

Variants

FirstLineTooLong

The complete first line exceeds the maximum allowed length

Fields

actual: usize

max: usize

InvalidConventionalFormat

The formatted message is not parseable as a conventional commit

This should never occur in normal use - it indicates a bug in the formatting logic.

Fields

reason: String

Trait Implementations

impl Clone for CommitMessageError

fn clone(&self) -> CommitMessageError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitMessageError

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

Formats the value using the given formatter.

impl Display for CommitMessageError

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

Formats the value using the given formatter.

impl Eq for CommitMessageError

impl Error for CommitMessageError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<CommitMessageError> for Error

fn from(value: CommitMessageError) -> Self

Converts to this type from the input type.

impl PartialEq for CommitMessageError

fn eq(&self, other: &CommitMessageError) -> 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 StructuralPartialEq for CommitMessageError