Struct BenchmarkSettings 

#[non_exhaustive]
pub struct BenchmarkSettings {
    pub setup: RunSetup,
    pub steps: u64,
    pub warmup: u64,
    pub global_warmup: u64,
    pub repetitions: u64,
}

Available on non-WebAssembly only.

Model, setup and lengths of one benchmark.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

setup: RunSetup

Values, base seed and scheduled actions of every repetition.

steps: u64

Timed steps per repetition.

warmup: u64

Untimed steps before each repetition’s timed ones, on that repetition’s own state.

Note that a GPU repetition with no warm-up times wgpu’s zero-fill of every buffer its build left unseeded, which runs in the first submission that touches the buffer. A warm-up of one step keeps it out of the timed steps.

global_warmup: u64

Untimed steps of one throwaway state before the first repetition, to bring the hardware off its idle clocks.

repetitions: u64

Number of timed repetitions, each on a freshly built state.

Implementations

impl BenchmarkSettings

pub fn new(setup: RunSetup, steps: u64) -> Self

Returns settings that time steps steps of setup once, with no warm-up.

Trait Implementations

impl Clone for BenchmarkSettings

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BenchmarkSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.