Skip to main content

Finding

Struct Finding 

Source
pub struct Finding {
    pub check_id: String,
    pub code: String,
    pub severity: FindingSeverity,
    pub title: String,
    pub message: String,
    pub location: Option<FindingLocation>,
    pub evidence: Option<Value>,
    pub docs_url: Option<String>,
    pub fingerprint: Option<String>,
}
Expand description

A finding reported by the sensor.

Findings use a (check_id, code) tuple for identity. Combined with tool.name this forms the triple (tool, check_id, code) used for buildfix routing and cockpit policy (e.g., ("tokmd", "risk", "hotspot")).

Fields§

§check_id: String

Check category (e.g., “risk”, “contract”, “gate”).

§code: String

Finding code within the category (e.g., “hotspot”, “coupling”).

§severity: FindingSeverity

Severity level.

§title: String

Short title for the finding.

§message: String

Detailed message describing the finding.

§location: Option<FindingLocation>

Source location (if applicable).

§evidence: Option<Value>

Additional evidence data.

§docs_url: Option<String>

Documentation URL for this finding type.

§fingerprint: Option<String>

Stable identity fingerprint for deduplication and buildfix routing. BLAKE3 hash of (tool_name, check_id, code, location.path).

Implementations§

Source§

impl Finding

Source

pub fn new( check_id: impl Into<String>, code: impl Into<String>, severity: FindingSeverity, title: impl Into<String>, message: impl Into<String>, ) -> Finding

Create a new finding with required fields.

Source

pub fn with_location(self, location: FindingLocation) -> Finding

Add a location to the finding.

Source

pub fn with_evidence(self, evidence: Value) -> Finding

Add evidence to the finding.

Source

pub fn with_docs_url(self, url: impl Into<String>) -> Finding

Add a documentation URL to the finding.

Source

pub fn compute_fingerprint(&self, tool_name: &str) -> String

Compute a stable fingerprint from (tool_name, check_id, code, path).

Returns first 16 bytes (32 hex chars) of a BLAKE3 hash for compactness.

Source

pub fn with_fingerprint(self, tool_name: &str) -> Finding

Auto-compute and set fingerprint. Builder pattern.

Trait Implementations§

Source§

impl Clone for Finding

Source§

fn clone(&self) -> Finding

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Finding

Source§

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

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

impl<'de> Deserialize<'de> for Finding

Source§

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

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

impl Serialize for Finding

Source§

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

Serialize this value into the given Serde serializer. Read more

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> 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>,