Struct Helgrind

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

Available on crate feature default only.

The configuration for Helgrind

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

Example

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

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

Implementations

impl Helgrind

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

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

Create a new Helgrind configuration with initial command-line arguments

See also Callgrind::args and Helgrind::args

Examples

use iai_callgrind::Helgrind;

let config = Helgrind::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 Helgrind configuration

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

let config = Helgrind::default().args(["free-is-write=yes"]);

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

Enable this tool. This is the default.

See also Callgrind::enable

Examples

use iai_callgrind::Helgrind;

let config = Helgrind::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 Helgrind output

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

Examples

use iai_callgrind::{ErrorMetric, Helgrind};

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

Trait Implementations

impl AsRef<Tool> for Helgrind

fn as_ref(&self) -> &InternalTool

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

impl Clone for Helgrind

fn clone(&self) -> Helgrind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Helgrind

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

Formats the value using the given formatter.

impl Default for Helgrind

fn default() -> Self

Returns the “default value” for a type.

impl From<&Helgrind> for InternalTool

fn from(value: &Helgrind) -> Self

Converts to this type from the input type.

impl From<&mut Helgrind> for InternalTool

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

Converts to this type from the input type.

impl From<Helgrind> for InternalTool

fn from(value: Helgrind) -> Self

Converts to this type from the input type.