Struct Diagnostic 

#[non_exhaustive]
pub struct Diagnostic {
    pub rule: RuleId,
    pub severity: Severity,
    pub span: Span,
    pub message: Box<str>,
    pub citation: &'static str,
    pub fix: Option<FixProposal>,
}

A single diagnostic emitted by a rule check.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule: RuleId

severity: Severity

span: Span

Byte span in the original source buffer.

message: Box<str>

Human-readable description of the violation.

citation: &'static str

CAPCO section citation, e.g., “CAPCO-2023-§3.1”.

fix: Option<FixProposal>

Proposed fix, if the rule can generate one.

Implementations

impl Diagnostic

pub fn new( rule: RuleId, severity: Severity, span: Span, message: impl Into<Box<str>>, citation: &'static str, fix: Option<FixProposal>, ) -> Self

Construct a new diagnostic.

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.