Enum mit_commit_message_lints::lints::Lint

pub enum Lint {
    DuplicatedTrailers,
    PivotalTrackerIdMissing,
    JiraIssueKeyMissing,
    GitHubIdMissing,
    SubjectNotSeparateFromBody,
    SubjectLongerThan72Characters,
    SubjectNotCapitalized,
    SubjectEndsWithPeriod,
    BodyWiderThan72Characters,
    NotConventionalCommit,
    NotEmojiLog,
}

The lints that are supported

Variants

DuplicatedTrailers

PivotalTrackerIdMissing

JiraIssueKeyMissing

GitHubIdMissing

SubjectNotSeparateFromBody

SubjectLongerThan72Characters

SubjectNotCapitalized

SubjectEndsWithPeriod

BodyWiderThan72Characters

NotConventionalCommit

NotEmojiLog

Implementations

impl Lint

#[must_use]

pub fn name(self) -> &'static str

impl Lint

pub fn iterator() -> impl Iterator<Item = Lint>

#[must_use]

pub fn enabled_by_default(self) -> bool

#[must_use]

pub fn config_key(self) -> String

#[must_use]

pub fn lint(self, commit_message: &CommitMessage) -> Option<Problem>

pub fn from_names(names: Vec<&str>) -> Result<Vec<Lint>, Error>

Try and convert a list of names into lints

Errors

If the lint does not exist

Trait Implementations

impl Clone for Lint

fn clone(&self) -> Lint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Lint

impl Debug for Lint

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

Formats the value using the given formatter.

impl Display for Lint

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

Formats the value using the given formatter.

impl Eq for Lint

impl Hash for Lint

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Lint

fn cmp(&self, other: &Lint) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Lint> for Lint

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialOrd<Lint> for Lint

fn partial_cmp(&self, other: &Lint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Lint

impl StructuralPartialEq for Lint

impl TryFrom<&'_ str> for Lint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(from: &str) -> Result<Self, Self::Error>

Performs the conversion.