Expand description
Canonical Mobench report models and context-specific renderers.
This crate is the report Module for Mobench. Provider and command Modules produce typed report data; JSON, Markdown, CSV, JUnit, comparison, and CI adapters render that data without reimplementing report semantics.
Structs§
- Benchmark
Failure Stats - Stable failure projection used by compatibility and CI reports.
- Benchmark
Resource Usage - Canonical resource statistics associated with a benchmark.
- Benchmark
Stats - Canonical statistics and diagnostics for one benchmark function.
- Canonical
Summary V2 - Canonical authenticated report published as
summary.v2.json. - Check
RunAnnotation - Check
RunOutput - Check
RunRequest - Compare
Report - Deterministic comparison between two canonical summaries.
- Compare
Row - Device
Summary - Results attributed to one device.
- Regression
Finding - One metric whose candidate value crosses the configured regression gate.
- Summary
Report - Canonical compatibility summary consumed by every report adapter.
Enums§
- RunOutcome
- Command-level terminal state included in the canonical v2 report.
Constants§
Functions§
- compare_
summaries - Compare two canonical summary models in deterministic device/function order.
- comparison_
json - JSON projection used by compatibility summaries and GitHub adapters.
- csv_
field - Encode one untrusted CSV field according to RFC 4180.
- detect_
regressions - format_
cpu_ total_ duration_ ms - format_
duration_ smart - format_
failure_ elapsed_ ms - format_
ms - markdown_
inline_ code - Wrap untrusted text in a safe inline-code span.
- markdown_
inline_ field_ text - Preserve benign report fields while encoding Markdown-active input.
- markdown_
inline_ text - Encode untrusted text for an inline Markdown context, including headings.
- markdown_
link_ destination - Encode an untrusted relative path for a Markdown link destination.
- markdown_
table_ cell_ text - Encode untrusted text for a GitHub-flavored Markdown table cell.
- markdown_
table_ field_ text - Preserve benign table fields while encoding Markdown-active input.
- render_
compare_ markdown - render_
csv_ summary - Render the released RFC 4180 CSV report from the canonical model.
- render_
junit_ report - Render JUnit for CI consumers from the canonical model and regression set.
- render_
markdown_ summary - Render the released Markdown compatibility report from the canonical model.
- render_
sticky_ comment