Enum PluginEvents 

pub enum PluginEvents<'a> {
    GroupBenchNumIters {
        num_iter: usize,
    },
    GroupNumIters {
        num_iter: usize,
    },
    GroupStart {
        runner_name: Option<&'a str>,
        group_name: Option<&'a str>,
        output_value_column_title: &'static str,
    },
    GroupStop {
        runner_name: Option<&'a str>,
        group_name: Option<&'a str>,
        results: &'a [BenchResult],
        output_value_column_title: &'static str,
    },
    BenchStart {
        bench_id: &'a BenchId,
    },
    BenchStop {
        bench_id: &'a BenchId,
        duration: u64,
    },
}

Events that can be emitted by the benchmark runner.

Variants

GroupBenchNumIters

The number of iterations for the benches in a group has been set. The previous event was GroupStart.

Fields

num_iter: usize

The number of iterations for each bench in the group. The whole group has the same number of iterations to be a fair comparison between the benches in the group.

GroupNumIters

The number of iterations for the bench group. The previous event was GroupStart.

Fields

num_iter: usize

Unlike GroupBenchNumIters, this is the number of iterations for the group. So each bench is run num_iter * num_group_iter times.

GroupStart

Profiling of the group started

Fields

runner_name: Option<&'a str>

The name of the runner

group_name: Option<&'a str>

The name of the group

output_value_column_title: &'static str

The name of the column of the output value.

GroupStop

Profiling of the group finished.

Fields

runner_name: Option<&'a str>

The name of the runner

group_name: Option<&'a str>

The name of the group

results: &'a [BenchResult]

The results of the group This will include the results of all the benchmarks in the group. It also contains delta information of the last run if available

output_value_column_title: &'static str

The name of the column of the output value.

BenchStart

A benchmark in a group is started. Note that a benchmark can be run multiple times for higher accuracy. BenchStart and BenchStop are not called for each iteration.

A group is iterated multiple times. This will be called for every iteration in the group.

Fields

bench_id: &'a BenchId

The bench id

BenchStop

A benchmark in a group is stopped.

Fields

bench_id: &'a BenchId

The bench id

duration: u64

The duration of the benchmark

Trait Implementations

impl<'a> Clone for PluginEvents<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for PluginEvents<'a>

impl<'a> Debug for PluginEvents<'a>

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

Formats the value using the given formatter.