Skip to main content

Crate fluxbench_cli

Crate fluxbench_cli 

Source
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§

AllocatorConfig
Allocator tracking configuration
CiConfig
CI/CD configuration
Cli
FluxBench CLI arguments
ExecutionConfig
Configuration for benchmark execution
Executor
Execute benchmarks and produce results (in-process mode)
FluxConfig
FluxBench configuration
IpcBenchmarkResult
Result from a benchmark run via IPC
IsolatedExecutor
Executor that runs benchmarks in isolated worker processes via IPC
OutputConfig
Output configuration
RunnerConfig
Runner configuration for benchmark execution
Supervisor
Supervisor that manages worker pool and distributes benchmarks
VisualsConfig
Visualization configuration
WorkerHandle
Worker process handle.

Enums§

Commands
CLI subcommands
IpcBenchmarkStatus
IsolationMode
Isolation mode for benchmark execution
SupervisorError

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.