Struct Memcheck

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

Available on crate feature default only.

The configuration for Memcheck

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

Example

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

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

Implementations

impl Memcheck

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

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

Create a new Memcheck configuration with initial command-line arguments

See also Callgrind::args and Memcheck::args

Examples

use iai_callgrind::Memcheck;

let config = Memcheck::with_args(["free-is-write=yes"]);

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

Valid arguments are https://valgrind.org/docs/manual/mc-manual.html#mc-manual.options 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::Memcheck;

let config = Memcheck::default().args(["show-leak-kinds=all"]);

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

Enable this tool. This is the default.

See also Callgrind::enable

Examples

use iai_callgrind::Memcheck;

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

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

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

Customize the format of the Memcheck output

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

Examples

use iai_callgrind::{ErrorMetric, Memcheck};

let config = Memcheck::default().format([ErrorMetric::Errors, ErrorMetric::SuppressedErrors]);

Trait Implementations

impl AsRef<Tool> for Memcheck

fn as_ref(&self) -> &InternalTool

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

impl Clone for Memcheck

fn clone(&self) -> Memcheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Memcheck

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

Formats the value using the given formatter.

impl Default for Memcheck

fn default() -> Self

Returns the “default value” for a type.

impl From<&Memcheck> for InternalTool

fn from(value: &Memcheck) -> Self

Converts to this type from the input type.

impl From<&mut Memcheck> for InternalTool

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

Converts to this type from the input type.

impl From<Memcheck> for InternalTool

fn from(value: Memcheck) -> Self

Converts to this type from the input type.