Struct BenchmarkSuite 

pub struct BenchmarkSuite { /* private fields */ }

A suite of benchmarks that can be run and recorded as a receipt.

Implementations

impl BenchmarkSuite

pub fn new() -> Self

Create a new benchmark suite with auto-detected commit hash and machine fingerprint.

pub fn with_commit_hash(commit_hash: impl Into<String>) -> Self

Create a new suite with explicit commit hash.

pub fn register( &mut self, name: impl Into<String>, bench: impl Fn() -> Result<BenchmarkResult, String> + Send + Sync + 'static, )

Register a benchmark with a name and callable.

The callable should perform the actual benchmark work and return a result with the measured elapsed time and iteration count.

pub fn run(&self) -> Result<BenchmarkReceipt, BenchError>

Run all registered benchmarks and return a receipt.

pub fn run_one(&self, name: &str) -> Result<BenchmarkResult, BenchError>

Run a specific named benchmark and return just that result.

pub fn benchmark_names(&self) -> Vec<&String>

Get the list of registered benchmark names.

Trait Implementations

impl Default for BenchmarkSuite

fn default() -> Self

Returns the “default value” for a type.