Struct BenchmarkSummary

pub struct BenchmarkSummary {

    pub version: String,
    pub kind: BenchmarkKind,
    pub summary_output: Option<SummaryOutput>,
    pub project_root: PathBuf,
    pub package_dir: PathBuf,
    pub benchmark_file: PathBuf,
    pub benchmark_exe: PathBuf,
    pub function_name: String,
    pub module_path: String,
    pub id: Option<String>,
    pub details: Option<String>,
    pub callgrind_summary: Option<CallgrindSummary>,
    pub tool_summaries: Vec<ToolSummary>,
}

Available on crate feature runner only.

The BenchmarkSummary containing all the information of a single benchmark run

This includes produced files, recorded callgrind events, performance regressions …

Fields

version: String

The version of this format. Only backwards incompatible changes cause an increase of the version

kind: BenchmarkKind

Whether this summary describes a library or binary benchmark

summary_output: Option<SummaryOutput>

The destination and kind of the summary file

project_root: PathBuf

The project’s root directory

package_dir: PathBuf

The directory of the package

benchmark_file: PathBuf

The path to the benchmark file

benchmark_exe: PathBuf

The path to the binary which is executed by valgrind. In case of a library benchmark this is the compiled benchmark file. In case of a binary benchmark this is the path to the command.

function_name: String

The name of the function under test

module_path: String

The rust path in the form bench_file::group::bench

id: Option<String>

The user provided id of this benchmark

details: Option<String>

More details describing this benchmark run

callgrind_summary: Option<CallgrindSummary>

The summary of the callgrind run

tool_summaries: Vec<ToolSummary>

The summary of other valgrind tool runs

Implementations

impl BenchmarkSummary

pub fn new( kind: BenchmarkKind, project_root: PathBuf, package_dir: PathBuf, benchmark_file: PathBuf, benchmark_exe: PathBuf, module_path: &ModulePath, function_name: &str, id: Option<String>, details: Option<String>, output: Option<SummaryOutput>, ) -> Self

Create a new BenchmarkSummary

Relative paths are made absolute with the project_root as base directory.

pub fn print_and_save(&self, output_format: &OutputFormatKind) -> Result<()>

pub fn check_regression( &self, is_regressed: &mut bool, fail_fast: bool, ) -> Result<()>

Check if this BenchmarkSummary has recorded any performance regressions

If the regressions are configured to be not fail_fast and there is a regressions, then the is_regressed variable is updated to true.

Errors

If the regressions are configured to be fail_fast an error is returned

pub fn compare_and_print( &self, id: &str, other: &Self, output_format: &OutputFormat, ) -> Result<()>

Trait Implementations

impl Debug for BenchmarkSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BenchmarkSummary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BenchmarkSummary

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for BenchmarkSummary

fn eq(&self, other: &BenchmarkSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BenchmarkSummary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BenchmarkSummary