Expand description
FluxBench CLI Library
This module provides the CLI infrastructure for benchmark binaries.
Use fluxbench::run() (or fluxbench_cli::run()) in your main function to get the full
fluxbench CLI experience with your registered benchmarks.
§Example
ⓘ
use fluxbench::prelude::*;
#[bench]
fn my_benchmark(b: &mut Bencher) {
b.iter(|| expensive_operation());
}
fn main() {
fluxbench_cli::run();
}Structs§
- Allocator
Config - Allocator tracking configuration
- CiConfig
- CI/CD configuration
- Cli
- FluxBench CLI arguments
- Execution
Config - Configuration for benchmark execution
- Executor
- Execute benchmarks and produce results (in-process mode)
- Flux
Config - FluxBench configuration
- IpcBenchmark
Result - Result from a benchmark run via IPC
- Isolated
Executor - Executor that runs benchmarks in isolated worker processes via IPC
- Output
Config - Output configuration
- Runner
Config - Runner configuration for benchmark execution
- Supervisor
- Supervisor that manages worker pool and distributes benchmarks
- Visuals
Config - Visualization configuration
- Worker
Handle - Worker process handle.
Enums§
- Commands
- CLI subcommands
- IpcBenchmark
Status - Status of a benchmark execution
- Isolation
Mode - Isolation mode for benchmark execution
- Supervisor
Error - Errors that can occur during supervisor operations
Functions§
- build_
report - Build a complete Report from execution results
- compute_
statistics - Compute statistics for benchmark results (parallelized with Rayon)
- execute_
verifications - Run comparisons, synthetics, and verifications against computed metrics
- format_
human_ output - Format a report for human-readable terminal display
- run
- Run the FluxBench CLI with the given arguments. This is the main entry point for benchmark binaries.
- run_
with_ cli - Run the FluxBench CLI with pre-parsed arguments.