Available on crate feature
api only.Expand description
The api contains all elements which the runner can understand
Structs§
- Binary
Benchmark - The model for the
#[binary_benchmark]attribute or the equivalent from the low level api - Binary
Benchmark Bench - The model for the
#[bench]attribute or the low level equivalent - Binary
Benchmark Config - The model for the configuration in binary benchmarks
- Binary
Benchmark Group - The model for the
binary_benchmark_groupmacro - Binary
Benchmark Groups - The model for the main! macro
- Cachegrind
Metric Iter - An iterator over the variants of CachegrindMetric
- Cachegrind
Regression Config - The model for the regression check configuration of Cachegrind
- Callgrind
Regression Config - The model for the regression check configuration of Callgrind
- Command
- The model for the command returned by the binary benchmark function
- Delay
- The delay of the
Command - Dhat
Metric Iter - An iterator over the variants of DhatMetric
- Dhat
Regression Config - The model for the regression check configuration of DHAT
- Error
Metric Iter - An iterator over the variants of ErrorMetric
- Event
Kind Iter - An iterator over the variants of EventKind
- Fixtures
- The fixtures to copy into the
Sandbox - Flamegraph
Config - The model for the configuration of flamegraphs
- Library
Benchmark - The model for the
#[library_benchmark]attribute - Library
Benchmark Bench - The model for the
#[bench]attribute in a#[library_benchmark] - Library
Benchmark Config - The model for the configuration in library benchmarks
- Library
Benchmark Group - The model for the
library_benchmark_groupmacro - Library
Benchmark Groups - The model for the
mainmacro - Output
Format - The configuration values for the output format
- RawArgs
- The raw arguments to pass to a valgrind tool
- Sandbox
- The sandbox to run the benchmarks in
- Tool
- The tool configuration
- Tools
- The configurations of all tools to run in addition to the default tool
Enums§
- Cachegrind
Metric - All metrics which cachegrind produces and additionally some derived events
- Cachegrind
Metrics - A collection of groups of
CachegrindMetrics - Callgrind
Metrics - A collection of groups of
EventKinds - Delay
Kind - The kind of
Delay - Dhat
Metric - The metrics collected by DHAT
- Dhat
Metrics - A collection of groups of
DhatMetrics - Direction
- The
Directionin which the flamegraph should grow. - Entry
Point - The
EntryPointof a benchmark - Error
Metric - The error metrics from a tool which reports errors
- Event
Kind - All
EventKinds callgrind produces and additionally some derived events - Exit
With - Set the expected exit status of a benchmarked binary
- Flamegraph
Kind - The kind of
Flamegraphwhich is going to be constructed - Limit
- A
Limitwhich can be either an integer or a float - Pipe
- Configure the
Streamwhich should be used as pipe inStdin::Setup - Stdin
- This is a special
Stdiofor the stdin method ofCommand - Stdio
- Configure the
StdioofStdin,StdoutandStderr - Tool
Flamegraph Config - The tool specific flamegraph configuration
- Tool
Output Format - The tool specific metrics to show in the terminal output
- Tool
Regression Config - The tool specific regression check configuration
- Valgrind
Tool - The valgrind tools which can be run
Functions§
- update_
option - Update the value of an
Option