Trait EffortlessSensor 

pub trait EffortlessSensor {
    type Settings: Serialize + DeserializeOwned;

    // Required methods
    fn name(&self) -> &str;
    fn version(&self) -> &str;
    fn run(
        &self,
        settings: &Self::Settings,
        substrate: &RepoSubstrate,
    ) -> Result<SensorReport>;
}

Trait for effortless code quality sensors.

A sensor receives a pre-built RepoSubstrate (shared context from a single tokei scan + git diff) and produces a SensorReport.

Design

• Settings: Each sensor defines its own settings type.
• Substrate: Shared context eliminates redundant I/O across sensors.
• Report: Standardized envelope for cross-fleet aggregation.

Required Associated Types

type Settings: Serialize + DeserializeOwned

Settings type for this sensor (must be JSON-serializable).

Required Methods

fn name(&self) -> &str

Sensor name (e.g., “tokmd”, “coverage-bot”).

fn version(&self) -> &str

Sensor version (e.g., “1.5.0”).

fn run( &self, settings: &Self::Settings, substrate: &RepoSubstrate, ) -> Result<SensorReport>

Run the sensor with the given settings and substrate.

Implementors