Struct diol::Bench

pub struct Bench {
    pub config: BenchConfig,
    pub groups: Vec<(Vec<(String, Box<dyn Register<Box<dyn Arg>>>)>, (TypeId, Vec<Box<dyn Arg>>))>,
}

main benchmark entry point, used to register functions and arguments, then run benchmarks.

Fields

config: BenchConfig

groups: Vec<(Vec<(String, Box<dyn Register<Box<dyn Arg>>>)>, (TypeId, Vec<Box<dyn Arg>>))>

Implementations

impl Bench

pub fn new(config: impl AsRef<BenchConfig>) -> Self

create a bench object from the given configuration.

pub fn register_many<T: Arg>( &mut self, f: impl RegisterMany<T>, args: impl IntoIterator<Item = T> )

register multiple functions that should be compared against each other during benchmarking, all taking the same arguments.

pub fn register<T: Arg>( &mut self, f: impl Register<T>, args: impl IntoIterator<Item = T> )

register a function for benchmarking, and the arguments that should be passed to it.

pub fn run(&mut self) -> Result<BenchResult>

run the benchmark, and write the results to stdout, and optionally to a file, depending on the configuration options.