Struct Bbv

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

Available on crate feature default only.

The configuration for the experimental bbv

Can be specified in crate::LibraryBenchmarkConfig::tool or crate::BinaryBenchmarkConfig::tool.

Example

use iai_callgrind::{LibraryBenchmarkConfig, main, Bbv};

main!(
    config = LibraryBenchmarkConfig::default()
        .tool(Bbv::default());
    library_benchmark_groups = some_group
);

Implementations

impl Bbv

pub fn with_args<I, T>(args: T) -> Self

where I: AsRef<str>, T: IntoIterator<Item = I>,

Create a new BBV configuration with initial command-line arguments

See also Callgrind::args and Bbv::args

Examples

use iai_callgrind::Bbv;

let config = Bbv::with_args(["interval-size=10000"]);

pub fn args<I, T>(&mut self, args: T) -> &mut Self

where I: AsRef<str>, T: IntoIterator<Item = I>,

Add command-line arguments to the BBV configuration

Valid arguments are https://valgrind.org/docs/manual/bbv-manual.html#bbv-manual.usage and the core valgrind command-line arguments https://valgrind.org/docs/manual/manual-core.html#manual-core.options.

See also Callgrind::args

Examples

use iai_callgrind::Bbv;

let config = Bbv::default().args(["interval-size=10000"]);

pub fn enable(&mut self, value: bool) -> &mut Self

Enable this tool. This is the default.

See also Callgrind::enable

use iai_callgrind::Bbv;

let config = Bbv::default().enable(false);

Trait Implementations

impl AsRef<Tool> for Bbv

fn as_ref(&self) -> &InternalTool

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

impl Clone for Bbv

fn clone(&self) -> Bbv

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bbv

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

Formats the value using the given formatter.

impl Default for Bbv

fn default() -> Self

Returns the “default value” for a type.

impl From<&Bbv> for InternalTool

fn from(value: &Bbv) -> Self

Converts to this type from the input type.

impl From<&mut Bbv> for InternalTool

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

Converts to this type from the input type.

impl From<Bbv> for InternalTool

fn from(value: Bbv) -> Self

Converts to this type from the input type.