Struct criterion_linux_perf::PerfMeasurement

pub struct PerfMeasurement { /* fields omitted */ }

The measurement type to be used with Criterion::with_measurement().

The default measurement created by PerfMeasurement::default() is PerfMode::Instructions.

Implementations

impl PerfMeasurement

pub fn new(mode: PerfMode) -> Self

Create a new measurement, using the given PerfMode event.

Trait Implementations

impl Clone for PerfMeasurement

pub fn clone(&self) -> PerfMeasurement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PerfMeasurement

pub fn default() -> Self

Returns the "default value" for a type.

impl Measurement for PerfMeasurement

type Intermediate = Counter

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 = u64

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

pub fn start(&self) -> Self::Intermediate

Criterion.rs will call this before iterating the benchmark.

pub fn end(&self, counter: Self::Intermediate) -> Self::Value

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

pub fn add(&self, v1: &Self::Value, v2: &Self::Value) -> Self::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.

pub fn zero(&self) -> Self::Value

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

pub fn to_f64(&self, val: &Self::Value) -> f64

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

pub fn formatter(&self) -> &dyn ValueFormatter

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