Skip to main content

Crate mobench_report

Crate mobench_report 

Source
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§

BenchmarkFailureStats
Stable failure projection used by compatibility and CI reports.
BenchmarkResourceUsage
Canonical resource statistics associated with a benchmark.
BenchmarkStats
Canonical statistics and diagnostics for one benchmark function.
CanonicalSummaryV2
Canonical authenticated report published as summary.v2.json.
CheckRunAnnotation
CheckRunOutput
CheckRunRequest
CompareReport
Deterministic comparison between two canonical summaries.
CompareRow
DeviceSummary
Results attributed to one device.
RegressionFinding
One metric whose candidate value crosses the configured regression gate.
SummaryReport
Canonical compatibility summary consumed by every report adapter.

Enums§

RunOutcome
Command-level terminal state included in the canonical v2 report.

Constants§

GITHUB_CHECK_ANNOTATION_LIMIT
MEMORY_BASELINE_GAP_NOTE

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