Enum codspeed_criterion_compat::SamplingMode

pub enum SamplingMode {
    Auto,
    Linear,
    Flat,
}

This enum allows the user to control how Criterion.rs chooses the iteration count when sampling. The default is Auto, which will choose a method automatically based on the iteration time during the warm-up phase.

Variants

Auto

Criterion.rs should choose a sampling method automatically. This is the default, and is recommended for most users and most benchmarks.

Linear

Scale the iteration count in each sample linearly. This is suitable for most benchmarks, but it tends to require many iterations which can make it very slow for very long benchmarks.

Flat

Keep the iteration count the same for all samples. This is not recommended, as it affects the statistics that Criterion.rs can compute. However, it requires fewer iterations than the Linear method and therefore is more suitable for very long-running benchmarks where benchmark execution time is more of a problem and statistical precision is less important.

Trait Implementations

impl Clone for SamplingMode

fn clone(&self) -> SamplingMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingMode

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

Formats the value using the given formatter.

impl Copy for SamplingMode