Struct Finding 

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

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")).

Examples

use tokmd_envelope::{Finding, FindingSeverity, FindingLocation};

let finding = Finding::new(
    "risk", "hotspot",
    FindingSeverity::Warn,
    "High-churn file",
    "src/lib.rs modified 42 times in 30 days",
).with_location(FindingLocation::path_line("src/lib.rs", 1));

assert_eq!(finding.check_id, "risk");
assert_eq!(finding.code, "hotspot");
assert!(finding.location.is_some());

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

impl Finding

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

Create a new finding with required fields.

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

Add a location to the finding.

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

Add evidence to the finding.

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

Add a documentation URL to the finding.

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.

Examples

use tokmd_envelope::{Finding, FindingSeverity, FindingLocation};

let f = Finding::new("risk", "hotspot", FindingSeverity::Warn, "Churn", "high")
    .with_location(FindingLocation::path("src/lib.rs"));
let fp = f.compute_fingerprint("tokmd");
assert_eq!(fp.len(), 32);

// Same inputs produce same fingerprint
let f2 = Finding::new("risk", "hotspot", FindingSeverity::Warn, "Churn", "high")
    .with_location(FindingLocation::path("src/lib.rs"));
assert_eq!(f2.compute_fingerprint("tokmd"), fp);

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

Auto-compute and set fingerprint. Builder pattern.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Finding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finding

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Finding

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

where __S: Serializer,

Serialize this value into the given Serde serializer.