Struct OffenderRecord 

pub struct OffenderRecord {
    pub path: PathBuf,
    pub function: Option<String>,
    pub start_line: u32,
    pub end_line: u32,
    pub start_col: Option<u32>,
    pub metric: String,
    pub value: f64,
    pub limit: f64,
    pub severity: Severity,
}

One metric-threshold violation, language-agnostic and format-agnostic.

Paths are stored as PathBuf so output writers can decide how to surface non-UTF-8 components (skip, replace, or fail) rather than silently lossy-converting.

Fields

path: PathBuf

Source file the violation was reported against.

function: Option<String>

Function or method name; None for file-level violations.

start_line: u32

First line covered by the violation (1-based).

end_line: u32

Last line covered by the violation (1-based, inclusive).

start_col: Option<u32>

Optional starting column (1-based).

metric: String

Metric identifier, e.g. "cyclomatic", "loc.lloc", "halstead.volume".

value: f64

Observed metric value.

limit: f64

Configured threshold the value exceeded.

severity: Severity

Severity assigned by the threshold engine.

Implementations

impl OffenderRecord

pub fn default_message(&self) -> String

Default human-readable message used by formats that do not carry their own templating. Renders "<metric> <value> exceeds limit <limit>" for higher-is-worse metrics and "<metric> <value> falls below limit <limit>" for the lower-is-worse mi.* family (#698) — the breach phrasing must match the direction the metric_catalog records, or an MI offender (value below the limit) reads as “exceeds” in Checkstyle / Clang / MSVC / SARIF output. An unknown metric id falls back to the higher-is-worse phrasing.

Values are formatted via MessageMetric: integer fast-path for safe integers, six-decimal rounding for non-integer finites, "NaN" / "inf" / "-inf" for non-finite values. The Display adapter writes directly into the format buffer, so this builds one String per call rather than three.

Trait Implementations

impl Clone for OffenderRecord

fn clone(&self) -> OffenderRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffenderRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OffenderRecord

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OffenderRecord

fn eq(&self, other: &OffenderRecord) -> 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 Serialize for OffenderRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OffenderRecord