Struct iai_callgrind::BenchmarkId

pub struct BenchmarkId { /* private fields */ }

An id for an Arg which can be used to produce unique ids from parameters

Implementations

impl BenchmarkId

pub fn new<T, P>(id: T, parameter: P) -> Self

where T: AsRef<str>, P: Display,

Create a new BenchmarkId.

Use BenchmarkId as an argument for the id of an Arg if you want to create unique ids from a parameter.

Examples

use iai_callgrind::{binary_benchmark_group, Arg, BinaryBenchmarkGroup, Run, BenchmarkId};
use std::ffi::OsStr;

binary_benchmark_group!(
    name = my_exe_group;
    benchmark = |"my-exe", group: &mut BinaryBenchmarkGroup| {
        for i in 0..10 {
            group.bench(Run::with_arg(
                Arg::new(BenchmarkId::new("foo with", i), [format!("--foo={i}")])
            ));
        }
    }
);

Trait Implementations

impl Clone for BenchmarkId

fn clone(&self) -> BenchmarkId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BenchmarkId

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

Formats the value using the given formatter.

impl From<BenchmarkId> for String

fn from(value: BenchmarkId) -> Self

Converts to this type from the input type.