Struct CachegrindRegressionConfig

pub struct CachegrindRegressionConfig {
    pub fail_fast: bool,
    pub hard_limits: Vec<(CachegrindMetric, Metric)>,
    pub soft_limits: Vec<(CachegrindMetric, f64)>,
}

Available on crate feature runner only.

The callgrind regression check configuration

Fields

fail_fast: bool

True if benchmarks should fail on first encountered failed regression check

hard_limits: Vec<(CachegrindMetric, Metric)>

The hard limits

soft_limits: Vec<(CachegrindMetric, f64)>

The soft limits

Trait Implementations

impl Clone for CachegrindRegressionConfig

fn clone(&self) -> CachegrindRegressionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CachegrindRegressionConfig

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

Formats the value using the given formatter.

impl Default for CachegrindRegressionConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CachegrindRegressionConfig

fn eq(&self, other: &CachegrindRegressionConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RegressionConfig<CachegrindMetric> for CachegrindRegressionConfig

fn check( &self, metrics_summary: &MetricsSummary<CachegrindMetric>, ) -> Vec<ToolRegression>

Check the MetricsSummary for regressions.

fn get_soft_limits(&self) -> &[(CachegrindMetric, f64)]

Return the soft limits

fn get_hard_limits(&self) -> &[(CachegrindMetric, Metric)]

Return the hard limits

fn check_and_print( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<ToolRegression>

Check for regressions and print them if present

fn check_regressions( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<RegressionMetrics<T>>

Check for regressions and return the RegressionMetrics

impl TryFrom<CachegrindRegressionConfig> for CachegrindRegressionConfig

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: CachegrindRegressionConfig) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for CachegrindRegressionConfig