Struct SensorReport 

pub struct SensorReport {
    pub schema: String,
    pub tool: ToolMeta,
    pub generated_at: String,
    pub verdict: Verdict,
    pub summary: String,
    pub findings: Vec<Finding>,
    pub artifacts: Option<Vec<Artifact>>,
    pub capabilities: Option<BTreeMap<String, CapabilityStatus>>,
    pub data: Option<Value>,
}

Sensor report envelope for multi-sensor integration.

The envelope provides a standardized JSON format that allows sensors to integrate with external orchestrators (“directors”) that aggregate reports from multiple code quality sensors into a unified PR view.

Design Principles

• Stable top-level, rich underneath: Minimal stable envelope; tool-specific richness in data
• Verdict-first: Quick pass/fail/warn determination without parsing tool-specific data
• Findings are portable: Common finding structure for cross-tool aggregation
• Self-describing: Schema version and tool metadata enable forward compatibility

Fields

schema: String

Schema identifier (e.g., “sensor.report.v1”).

tool: ToolMeta

Tool identification.

generated_at: String

Generation timestamp (ISO 8601 format).

verdict: Verdict

Overall result verdict.

summary: String

Human-readable one-line summary.

findings: Vec<Finding>

List of findings (may be empty).

artifacts: Option<Vec<Artifact>>

Related artifact paths.

capabilities: Option<BTreeMap<String, CapabilityStatus>>

Capability availability status for “No Green By Omission”.

Reports which checks were available, unavailable, or skipped. Enables directors to distinguish between “all passed” and “nothing ran”.

data: Option<Value>

Tool-specific payload (opaque to director).

Implementations

impl SensorReport

pub fn new( tool: ToolMeta, generated_at: String, verdict: Verdict, summary: String, ) -> SensorReport

Create a new sensor report with the current version.

pub fn add_finding(&mut self, finding: Finding)

Add a finding to the report.

pub fn with_artifacts(self, artifacts: Vec<Artifact>) -> SensorReport

Set the artifacts section.

pub fn with_data(self, data: Value) -> SensorReport

Set the data payload.

pub fn with_capabilities( self, capabilities: BTreeMap<String, CapabilityStatus>, ) -> SensorReport

Set the capabilities section for “No Green By Omission”.

pub fn add_capability( &mut self, name: impl Into<String>, status: CapabilityStatus, )

Add a single capability to the report.

Trait Implementations

impl Clone for SensorReport

fn clone(&self) -> SensorReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SensorReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SensorReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SensorReport

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.