Struct BenchBuilder

pub struct BenchBuilder<'a, T, R> { /* private fields */ }

Builder for creating a Bench instance.

Implementations

impl<'a, T, R> BenchBuilder<'a, T, R>

pub fn new( functions: Vec<BenchFnNamed<'a, T, R>>, argfunc: BenchFnArg<T>, sizes: Vec<usize>, ) -> Self

Creates a new BenchBuilder with required parameters.

Mandatory parameters are required upfront and optional parameters are configured through method chaining.

By default, repetitions is set to 1, parallel to false, and assert_equal to false.

pub fn repetitions(self, repetitions: usize) -> Self

Sets the number of times to time each (input size, function) pair.

For each (input size, function) pair, the function is timed repetitions times and the average over the repetitions is used as the benchmark value.

Default: 1.

pub fn parallel(self, parallel: bool) -> Self

Sets whether to run (input size, function) pair benchmarks in parallel.

Default: false.

pub fn assert_equal(self, assert_equal: bool) -> Self

Sets whether to assert that all function return values are equal.

When set to true, if there exists an input size such that the function return values are not equal, then the program panics.

If repetitions is greater than 1, then for each input size, only the function return values from the last repetition are compared.

Default: false.

pub fn build(self) -> Result<Bench<'a, T, R>, BenchBuilderError>

Validates the configuration and builds a Bench instance.