Struct iai_callgrind::BinaryBenchmarkGroup

pub struct BinaryBenchmarkGroup(/* private fields */);

The BinaryBenchmarkGroup lets you configure binary benchmark Runs

Implementations

impl BinaryBenchmarkGroup

pub fn bench<T>(&mut self, run: T) -> &mut Self

where T: Into<InternalRun>,

Specify a Run to benchmark a binary

You can specify a crate’s binary either at group level with the simple name of the binary (say my-exe) or at bench level with env!("CARGO_BIN_EXE_my-exe"). See examples.

See also Run for more details.

Examples

If your crate has a binary my-exe (the name key of a [[bin]] entry in Cargo.toml), specifying "my-exe" in the benchmark argument sets the command for all Run arguments and it’s sufficient to specify only Arg with Run::with_arg:

use iai_callgrind::{binary_benchmark_group, Arg, BinaryBenchmarkGroup, Run};

binary_benchmark_group!(
    name = my_exe_group;
    benchmark = |"my-exe", group: &mut BinaryBenchmarkGroup| {
        group.bench(Run::with_arg(Arg::new("foo", &["foo"])));
    }
);

Without the command at group level:

use iai_callgrind::{binary_benchmark_group, Arg, BinaryBenchmarkGroup, Run};

binary_benchmark_group!(
    name = my_exe_group;
    benchmark = |group: &mut BinaryBenchmarkGroup| {
        // Usually you should use `env!("CARGO_BIN_EXE_my-exe")` if `my-exe` is a binary
        // of your crate
        group.bench(Run::with_cmd("/path/to/my-exe", Arg::new("foo", &["foo"])));
    }
);

Trait Implementations

impl AsRef<BinaryBenchmarkGroup> for BinaryBenchmarkGroup

fn as_ref(&self) -> &BinaryBenchmarkGroup

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BinaryBenchmarkGroup

fn clone(&self) -> BinaryBenchmarkGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryBenchmarkGroup

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

Formats the value using the given formatter.

impl Default for BinaryBenchmarkGroup

fn default() -> BinaryBenchmarkGroup

Returns the “default value” for a type.

impl From<&BinaryBenchmarkGroup> for InternalBinaryBenchmarkGroup

fn from(value: &BinaryBenchmarkGroup) -> Self

Converts to this type from the input type.

impl From<&mut BinaryBenchmarkGroup> for InternalBinaryBenchmarkGroup

fn from(value: &mut BinaryBenchmarkGroup) -> Self

Converts to this type from the input type.

impl From<BinaryBenchmarkGroup> for BinaryBenchmarkGroup

fn from(value: InternalBinaryBenchmarkGroup) -> Self

Converts to this type from the input type.

impl From<BinaryBenchmarkGroup> for InternalBinaryBenchmarkGroup

fn from(value: BinaryBenchmarkGroup) -> Self

Converts to this type from the input type.