Struct RuleViolation 

#[non_exhaustive]
pub struct RuleViolation {
    pub rule_name: &'static str,
    pub message: String,
    pub position: Option<usize>,
    pub fragment: Option<String>,
}

A single rule violation with context.

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_name: &'static str

Which rule detected the violation.

message: String

Human-readable description of the violation.

position: Option<usize>

Byte offset in the input where the violation was found, if applicable.

fragment: Option<String>

The problematic fragment, if applicable.

Implementations

impl RuleViolation

pub fn new(rule_name: &'static str, message: impl Into<String>) -> Self

Create a new violation with the given rule name and message.

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

Set the byte position where the violation was detected.

pub fn with_fragment(self, fragment: impl Into<String>) -> Self

Set the problematic fragment.

Trait Implementations

impl Clone for RuleViolation

fn clone(&self) -> RuleViolation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleViolation

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

Formats the value using the given formatter.

impl Display for RuleViolation

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

Formats the value using the given formatter.

impl PartialEq for RuleViolation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RuleViolation

impl StructuralPartialEq for RuleViolation