Struct ReportBuilder 

pub struct ReportBuilder {
    report: Report,
    pending_labels: Vec<String>,
}

Fluent builder for a Report. Finalise with ReportBuilder::build.

Fields

report: Report

pending_labels: Vec<String>

Implementations

impl ReportBuilder

pub fn new( plugin_id: impl Into<String>, plugin_version: impl Into<String>, ) -> Self

Start a new report for a plugin. id and version typically come from env!("CARGO_PKG_NAME") / env!("CARGO_PKG_VERSION").

pub fn display_name(self, name: impl Into<String>) -> Self

Set a human-friendly plugin name for the frontend (e.g. "YARA Scanner").

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

Set a short summary shown at the top of the report.

pub fn verdict( self, classification: Classification, score: Option<u8>, confidence: Option<Confidence>, ) -> Self

Set the verdict. score is optional (pass None when the plugin has no numeric score). Can be called before or after labels.

pub fn labels<I, S>(self, labels: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Append labels to the verdict. Can be called before or after verdict - labels are merged at build time.

pub fn indicator(self, ind: Indicator) -> Self

Add an indicator of compromise to the report’s semantic layer.

pub fn ttp(self, ttp: Ttp) -> Self

Add a MITRE ATT&CK technique observation.

pub fn artifact(self, artifact: ArtifactRef) -> Self

Register a sibling PluginResult as an artifact.

pub fn section<F>( self, id: impl Into<String>, title: impl Into<String>, build: F, ) -> Self

where F: FnOnce(SectionBuilder) -> SectionBuilder,

Append a section. The closure receives a SectionBuilder and returns it - the typical shape is |s| s.heading(2, "...").table(...).

pub fn raw(self, value: impl Serialize) -> Self

Attach the plugin’s native JSON as an escape hatch. Rarely needed - prefer typed blocks.

pub fn build(self) -> Report

Finalize and return the Report. Merges any pending labels into the verdict.