Struct codspeed_criterion_compat::measurement::WallTime

pub struct WallTime;

WallTime is the default measurement in Criterion.rs. It measures the elapsed time from the beginning of a series of iterations to the end.

Trait Implementations

impl Measurement for WallTime

type Intermediate = Instant

This type represents an intermediate value for the measurements. It will be produced by the start function and passed to the end function. An example might be the wall-clock time as of the start call.

type Value = Duration

This type is the measured value. An example might be the elapsed wall-clock time between the start and end calls.

fn start(&self) -> <WallTime as Measurement>::Intermediate

Criterion.rs will call this before iterating the benchmark.

fn end( &self, i: <WallTime as Measurement>::Intermediate ) -> <WallTime as Measurement>::Value

Criterion.rs will call this after iterating the benchmark to get the measured value.

fn add( &self, v1: &<WallTime as Measurement>::Value, v2: &<WallTime as Measurement>::Value ) -> <WallTime as Measurement>::Value

Combine two values. Criterion.rs sometimes needs to perform measurements in multiple batches of iterations, so the value from one batch must be added to the sum of the previous batches.

fn zero(&self) -> <WallTime as Measurement>::Value

Return a “zero” value for the Value type which can be added to another value.

fn to_f64(&self, val: &<WallTime as Measurement>::Value) -> f64

Converts the measured value to f64 so that it can be used in statistical analysis.

fn formatter(&self) -> &dyn ValueFormatter

Return a trait-object reference to the value formatter for this measurement.