bench_matrix 0.2.1

A utility crate for defining and running parameterized benchmarks, with optional Criterion integration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

//! `bench_matrix` is a utility crate for defining and orchestrating
//! parameterized benchmarks, allowing for the generation and execution
//! of tests across a matrix of configurations. It offers optional
//! integration with the Criterion benchmarking harness.

// Define modules
#[cfg(feature = "criterion_integration")]
pub mod criterion_runner;
pub mod generator; // For generate_combinations
pub mod params; // For MatrixCellValue, AbstractCombination, etc. // For the Criterion-specific orchestrator

// Re-export key types for easier public use
pub use generator::generate_combinations;
pub use params::{AbstractCombination, MatrixCellValue};

// --- Re-exports for Criterion Integration (from the submodules) ---

// Common types used by both async and sync criterion runners
#[cfg(feature = "criterion_integration")]
pub use criterion_runner::{ExtractorFn, GlobalSetupFn, GlobalTeardownFn};

// Async specific exports
#[cfg(feature = "criterion_integration")]
pub use criterion_runner::async_suite::{
  AsyncBenchmarkLogicFn,
  AsyncBenchmarkSuite,
  // Function signature types for async benchmarks
  AsyncSetupFn,
  AsyncTeardownFn,
};

// Sync specific exports
#[cfg(feature = "criterion_integration")]
pub use criterion_runner::sync_suite::{
  SyncBenchmarkLogicFn,
  SyncBenchmarkSuite,
  // Function signature types for sync benchmarks
  SyncSetupFn,
  SyncTeardownFn,
};