Skip to main content

Crate perfgate_render

Crate perfgate_render 

Source
Expand description

Rendering utilities for perfgate output.

This crate provides functions for rendering performance comparison results as markdown tables and GitHub Actions annotations.

§Example

use perfgate_render::{render_markdown, github_annotations};
use perfgate_types::{CompareReceipt, Delta, Metric, MetricStatus, MetricStatistic};
use std::collections::BTreeMap;

fn example() {
    // Create a CompareReceipt (simplified example)
    // let compare = CompareReceipt { ... };
    // let markdown = render_markdown(&compare);
    // let annotations = github_annotations(&compare);
}

Functions§

direction_str
Return a human-readable label for a budget Direction.
format_metric
Return the canonical string key for a Metric.
format_metric_with_statistic
Format a metric key, appending the statistic name when it is not the default (median).
format_pct
Format a fractional change as a percentage string.
format_value
Format a metric value for display.
github_annotations
Produce GitHub Actions annotation strings from a CompareReceipt.
markdown_template_context
Build the JSON context object used by render_markdown_template.
metric_status_icon
Return an emoji icon for a MetricStatus.
metric_status_str
Return a lowercase string label for a MetricStatus.
parse_reason_token
Parse a verdict reason token like "wall_ms_warn" into its metric and status.
render_markdown
Render a CompareReceipt as a Markdown table for PR comments.
render_markdown_template
Render a CompareReceipt using a custom Handlebars template.
render_reason_line
Render a single verdict reason token as a human-readable bullet line.