Enum Check 

pub enum Check {
    BareUrl,
    EmptyHeading,
    LinkSyntaxInvalid,
    LongLine,
    MissingSpaceAfterHeading,
    MultipleBlankLines,
    TabCharacter,
    TrailingBlankLines,
    TrailingWhitespace,
    UnclosedCodeFence,
}

The ten checks.

The wire names are a stable output contract. Check::as_str is the only place a name is written.

Check::ALL is what the tests iterate, and it is a hand-maintained list: Rust cannot enumerate an enum without a derive macro, so nothing makes a new variant appear in it. What does force the author’s hand is that the three match self methods below are exhaustive - a new variant fails to compile until all three are extended, and ALL sits immediately above them. Treat adding to ALL as part of adding a variant; a check missing from it silently drops out of every test in this module.

Variants

BareUrl

EmptyHeading

LinkSyntaxInvalid

LongLine

MissingSpaceAfterHeading

MultipleBlankLines

TabCharacter

TrailingBlankLines

TrailingWhitespace

UnclosedCodeFence

Implementations

impl Check

pub const ALL: [Check; 10]

Every check. The one place the vocabulary is listed.

pub const fn as_str(self) -> &'static str

The wire name, as it appears in a finding’s kind.

pub const fn severity(self) -> Severity

How badly this check’s subject breaks the document.

One rule decides all ten: does it change how the document renders?

• Severity::Error - the rest of the file renders as something else. Only an unclosed fence does that, and it does it to every line below itself.
• Severity::Warning - that line renders wrong. A heading that is not a heading, a link that is not a link.
• Severity::Info - renders identically; this is hygiene.

The rule matters because drep lint-docs --strict and --fail-on downstream both gate on it, and “whitespace blocks a commit” is the calibration failure that makes a gate get switched off.

pub const fn suggestion(self) -> &'static str

What to do about it. Advice, never a literal replacement.

A literal replacement would be misleading for checks whose fix requires judgment, so this field consistently describes the intended result.

Trait Implementations

impl Clone for Check

fn clone(&self) -> Check

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Check

impl Debug for Check

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

Formats the value using the given formatter.

impl Eq for Check

impl Ord for Check

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Check

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Check

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Check