Struct RegressionConfig

pub struct RegressionConfig(/* private fields */);

Available on crate feature default only.

Configure performance regression checks and behavior

A performance regression check consists of an EventKind and a percentage over which a regression is assumed. If the percentage is negative, then a regression is assumed to be below this limit. The default EventKind is EventKind::Ir with a value of +10f64

If fail_fast is set to true, then the whole benchmark run fails on the first encountered regression. Else, the default behavior is, that the benchmark run fails with a regression error after all benchmarks have been run.

Examples

use iai_callgrind::{main, LibraryBenchmarkConfig, RegressionConfig};
main!(
    config = LibraryBenchmarkConfig::default()
                .regression(RegressionConfig::default());
    library_benchmark_groups = some_group
);

Implementations

impl RegressionConfig

Enable performance regression checks with a RegressionConfig

A performance regression check consists of an EventKind and a percentage over which a regression is assumed. If the percentage is negative, then a regression is assumed to be below this limit. The default EventKind is EventKind::Ir with a value of +10f64

If fail_fast is set to true, then the whole benchmark run fails on the first encountered regression. Else, the default behavior is, that the benchmark run fails with a regression error after all benchmarks have been run.

Examples

use iai_callgrind::{LibraryBenchmarkConfig, RegressionConfig};

main!(
    config = LibraryBenchmarkConfig::default()
                .regression(RegressionConfig::default());
    library_benchmark_groups = some_group
);

pub fn limits<T>(&mut self, targets: T) -> &mut Self

where T: IntoIterator<Item = (EventKind, f64)>,

Configure the limits percentages over/below which a performance regression can be assumed

A performance regression check consists of an EventKind and a percentage over which a regression is assumed. If the percentage is negative, then a regression is assumed to be below this limit.

If no limits or empty targets are specified with this function, the default EventKind is EventKind::Ir with a value of +10f64

Examples

use iai_callgrind::{EventKind, RegressionConfig};

let config = RegressionConfig::default().limits([(EventKind::Ir, 5f64)]);

pub fn fail_fast(&mut self, value: bool) -> &mut Self

If set to true, then the benchmarks fail on the first encountered regression

The default is false and the whole benchmark run fails with a regression error after all benchmarks have been run.

Examples

use iai_callgrind::RegressionConfig;

let config = RegressionConfig::default().fail_fast(true);

Trait Implementations

impl AsRef<RegressionConfig> for RegressionConfig

fn as_ref(&self) -> &InternalRegressionConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for RegressionConfig

fn clone(&self) -> RegressionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegressionConfig

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

Formats the value using the given formatter.

impl Default for RegressionConfig

fn default() -> RegressionConfig

Returns the “default value” for a type.

impl From<&RegressionConfig> for InternalRegressionConfig

fn from(value: &RegressionConfig) -> Self

Converts to this type from the input type.

impl From<&mut RegressionConfig> for InternalRegressionConfig

fn from(value: &mut RegressionConfig) -> Self

Converts to this type from the input type.

impl From<RegressionConfig> for InternalRegressionConfig

fn from(value: RegressionConfig) -> Self

Converts to this type from the input type.