Struct Diagnostic 

pub struct Diagnostic {
    pub rule: Cow<'static, str>,
    pub line: usize,
    pub column: usize,
    pub span: Range<usize>,
    pub message: String,
    pub fix: Option<Fix>,
    pub advisory: bool,
}

One issue at one source location, optionally with an automatic Fix. Spans are byte ranges into the original source string.

Fields

rule: Cow<'static, str>

Kebab-case identifier of the rule that produced this diagnostic. Cow so stdlib rules can borrow &'static str names while user rules with runtime-built names own the buffer. The dispatcher stamps this field after each rule’s check returns, so rule implementations do not set it.

line: usize

1-indexed line number of the diagnostic’s first byte.

column: usize

1-indexed codepoint column.

span: Range<usize>

Byte span within the source. source.get(span.clone()) is the substring the diagnostic refers to.

message: String

One-line human-readable message.

fix: Option<Fix>

Optional replacement covering span.

advisory: bool

Whether this diagnostic is advisory (informational; does not fail --check). Set by the dispatcher from the rule’s is_advisory().

Implementations

impl Diagnostic

pub fn at( doc: &Document, byte_offset: usize, local: Range<usize>, message: String, fix: Option<Fix>, ) -> Option<Self>

Build a diagnostic at a position within a borrowed source slice. byte_offset is the absolute offset of the slice’s first byte; local is the match range within that slice.

Returns None if the line-index lookup fails — never observed for offsets produced by pulldown-cmark, but the safe-fallback behaviour is to drop the diagnostic rather than panic. The dispatcher fills in rule and advisory after the containing rule’s check returns.

pub fn suppress_via(&self) -> String

Suppression marker text. The Markdown comment for muting this diagnostic on the next block is <!-- mdwright: allow rule-name -->.

pub fn severity(&self) -> Severity

Diagnostic severity derived from Self::advisory. Used by the v2 JSON Lines emitter and the rustc-style pretty header.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.