Struct criterion_perf_events::Perf

pub struct Perf { /* fields omitted */ }

perf implements criterion::measurement::Measurement so it can be used in criterion to measure perf events. Create a struct via Perf::new().

Methods

impl Perf

pub fn new(builder: PerfCounterBuilderLinux) -> Perf

Creates a new criterion measurement plugin that measures perf events.

Argument

• builder - A PerfCounterBuilderLinux from the crate perfcnt that is configured for the selected counter.

Remarks

Should only fail if you select a counter that is not available on your system or you do not have the necessarry access rights.

Trait Implementations

impl Measurement for Perf

type Intermediate = u64

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.

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

Criterion.rs will call this before iterating the benchmark.

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

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

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.

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

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

fn to_f64(&self, value: &Self::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.