Crate criterion_markdown 

Reads criterion benchmark results from target/criterion/ JSON files and renders a markdown table similar to criterion-table.

Example

fn main() -> anyhow::Result<()> {
    let markdown = criterion_markdown::render("target/criterion", std::iter::empty::<&str>())?;
    println!("{markdown}");
    Ok(())
}

Collapsible output

Use RenderOptions::collapsible to wrap the output in a <details><summary> tag:

use criterion_markdown::RenderOptions;

fn main() -> anyhow::Result<()> {
    let options = RenderOptions {
        collapsible: Some("Benchmark Results".into()),
    };
    let markdown = criterion_markdown::render_with_options(
        "target/criterion",
        std::iter::empty::<&str>(),
        &options,
    )?;
    println!("{markdown}");
    Ok(())
}

Structs

RenderOptions

Options for controlling the rendered markdown output.

Functions

render

Reads all benchmark results from the given criterion output directory and renders a markdown table.

render_with_options

Like render, but accepts additional RenderOptions to control output.