Struct Violation 

pub struct Violation {
    pub rule_id: RuleId,
    pub severity: Severity,
    pub message: String,
    pub file: PathBuf,
    pub line: Option<usize>,
    pub column: Option<usize>,
    pub fix_hint: Option<String>,
    pub snippet: Option<String>,
    pub source_url: Option<String>,
    pub detail: Option<String>,
    pub fixes: Vec<TextEdit>,
}

A concrete finding produced by a rule.

Fields

rule_id: RuleId

Rule that produced this finding.

severity: Severity

Effective severity (config overrides applied).

message: String

Human-readable description of the finding.

file: PathBuf

File the finding was raised against.

line: Option<usize>

1-based line number, if known.

column: Option<usize>

1-based column, if known.

fix_hint: Option<String>

Suggested remediation, if the rule offers one.

snippet: Option<String>

Offending source excerpt, if captured.

source_url: Option<String>

Link to the rule’s documentation page.

detail: Option<String>

Varying finding-specific detail (link target, offending phrase, duplicate line ref, YAML error text). Reporters show this once per row instead of repeating a boilerplate prefix on every message.

fixes: Vec<TextEdit>

Deterministic edits that, if applied, resolve this finding. Empty when no automated fix is available.

Implementations

impl Violation

pub fn new( rule_id: RuleId, severity: Severity, file: PathBuf, message: impl Into<String>, ) -> Self

Create a violation with no location or hint attached.

pub fn at(self, line: usize, column: usize) -> Self

Attach a 1-based line and column.

pub fn with_detail(self, detail: impl Into<String>) -> Self

Attach the varying finding-specific detail.

pub fn with_fix(self, fix: TextEdit) -> Self

Attach a deterministic text edit that resolves this finding.

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Violation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Violation

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

Formats the value using the given formatter.

impl Serialize for Violation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.