Skip to main content

Module summary

Module summary 

Source
Expand description

Structured bench summary - the typed counterpart to the standard subms JSON.

Build one with crate::summarize (or crate::summarize_lean for the sample-free variant). Hand the summary to crate::print_summary, crate::assert_p99_under, or crate::summary_to_json.

Field shape is byte-equivalent to Java’s SubMsBenchSummary / SubMsStageSummary.

Structs§

SubMsBenchDiff
Typed diff between a baseline and a candidate SubMsBenchSummary. Java counterpart: SubMsBenchDiff.
SubMsBenchSummary
Typed summary of one bench run. Mirrors the on-disk JSON downstream tooling persists per workload.
SubMsBenchSweep
A sweep is a collection of SubMsBenchSummary runs that share a workload but vary one or more input parameters - typically entries for scale-curve studies, or bloom_mode for a feature-toggle comparison.
SubMsMetricDiff
One row in a per-stage diff: a baseline value, a candidate value, and the deltas between them.
SubMsStageDiff
Per-stage diff: every percentile + mean compared between two runs of the same stage. worst_regression_pct is the most-positive delta_pct across all metrics - the headline number a CI gate keys off.
SubMsStageSummary
Per-stage summary. The counterpart of one stages.<name> entry in the subms JSON contract.