Struct Cachegrind

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

Available on crate feature default only.

The configuration for cachegrind

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

Example

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

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

Implementations

impl Cachegrind

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

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

Create a new Cachegrind configuration with initial command-line arguments

See also Callgrind::args and Cachegrind::args

Examples

use iai_callgrind::Cachegrind;

let config = Cachegrind::with_args(["intr-at-start=no"]);

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 Cachegrind configuration

Valid arguments are https://valgrind.org/docs/manual/cg-manual.html#cg-manual.cgopts 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::Cachegrind;

let config = Cachegrind::default().args(["intr-at-start=no"]);

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

Enable this tool. This is the default.

See also Callgrind::enable

Examples

use iai_callgrind::Cachegrind;

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

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

where I: Into<CachegrindMetrics>, T: IntoIterator<Item = I>,

Customize the format of the cachegrind output

See also Callgrind::format for more details and crate::CachegrindMetrics for valid metrics.

Examples

use iai_callgrind::{Cachegrind, CachegrindMetric, CachegrindMetrics};

let config =
    Cachegrind::default().format([CachegrindMetric::Ir.into(), CachegrindMetrics::CacheSim]);

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

where T: IntoIterator<Item = (CachegrindMetric, f64)>,

Configure the limits percentages over/below which a performance regression can be assumed

See also Callgrind::limits.

Examples

use iai_callgrind::{Cachegrind, CachegrindMetric};

let config = Cachegrind::default().limits([(CachegrindMetric::Ir, 5f64)]);

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

If set to true, then the benchmarks fail on the first encountered regression

The default is false and the whole benchmark run fails with a regression error after all benchmarks have been run.

Examples

use iai_callgrind::Cachegrind;

let config = Cachegrind::default().fail_fast(true);

Trait Implementations

impl AsRef<Tool> for Cachegrind

fn as_ref(&self) -> &InternalTool

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

impl Clone for Cachegrind

fn clone(&self) -> Cachegrind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cachegrind

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

Formats the value using the given formatter.

impl Default for Cachegrind

fn default() -> Self

Returns the “default value” for a type.

impl From<&Cachegrind> for InternalTool

fn from(value: &Cachegrind) -> Self

Converts to this type from the input type.

impl From<&mut Cachegrind> for InternalTool

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

Converts to this type from the input type.

impl From<Cachegrind> for InternalTool

fn from(value: Cachegrind) -> Self

Converts to this type from the input type.