Struct PlotConfiguration

pub struct PlotConfiguration { /* private fields */ }

Contains the configuration options for the plots generated by a particular benchmark or benchmark group.

use self::criterion::{Bencher, Criterion, PlotConfiguration, AxisScale};

let plot_config = PlotConfiguration::default()
    .summary_scale(AxisScale::Logarithmic);

// Using Criterion::default() for simplicity; normally you'd use the macros.
let mut criterion = Criterion::default();
let mut benchmark_group = criterion.benchmark_group("Group name");
benchmark_group.plot_config(plot_config);
// Use benchmark group

Implementations

impl PlotConfiguration

pub fn summary_scale(self, new_scale: AxisScale) -> PlotConfiguration

Set the axis scale (linear or logarithmic) for the summary plots. Typically, you would set this to logarithmic if benchmarking over a range of inputs which scale exponentially. Defaults to linear.

Trait Implementations

impl Clone for PlotConfiguration

fn clone(&self) -> PlotConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlotConfiguration

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

Formats the value using the given formatter.

impl Default for PlotConfiguration

fn default() -> PlotConfiguration

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte