Skip to main content

OffenderRecord

Struct OffenderRecord 

Source
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,
}
Expand description

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§

Source§

impl OffenderRecord

Source

pub fn default_message(&self) -> String

Default human-readable message used by formats that do not carry their own templating. "<metric> <value> exceeds limit <limit>", with values 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§

Source§

impl Clone for OffenderRecord

Source§

fn clone(&self) -> OffenderRecord

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OffenderRecord

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for OffenderRecord

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for OffenderRecord

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for OffenderRecord

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,