Struct Tool

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

Available on crate feature default only.

Configure to run other valgrind tools like DHAT or Massif in addition to callgrind

For a list of possible tools see ValgrindTool.

See also the Valgrind User Manual for details about possible tools and their command line arguments.

Examples

use iai_callgrind::{main, LibraryBenchmarkConfig, Tool, ValgrindTool};
main!(
    config = LibraryBenchmarkConfig::default()
                .tool(Tool::new(ValgrindTool::DHAT));
    library_benchmark_groups = some_group
);

Implementations

impl Tool

pub fn new(tool: ValgrindTool) -> Self

Create a new Tool configuration

Examples

use iai_callgrind::{Tool, ValgrindTool};

let tool = Tool::new(ValgrindTool::DHAT);

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

If true, enable running this Tool (Default: true)

Examples

use iai_callgrind::{Tool, ValgrindTool};

let tool = Tool::new(ValgrindTool::DHAT).enable(true);

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

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

Pass one or more arguments directly to the valgrind Tool

Examples

use iai_callgrind::{Tool, ValgrindTool};

let tool = Tool::new(ValgrindTool::DHAT).args(["--num-callers=5", "--mode=heap"]);

Trait Implementations

impl AsRef<Tool> for Tool

fn as_ref(&self) -> &InternalTool

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

impl Clone for Tool

fn clone(&self) -> Tool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl From<&Tool> for InternalTool

fn from(value: &Tool) -> Self

Converts to this type from the input type.

impl From<&mut Tool> for InternalTool

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

Converts to this type from the input type.

impl From<Tool> for InternalTool

fn from(value: Tool) -> Self

Converts to this type from the input type.

impl PartialEq for Tool

fn eq(&self, other: &Tool) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Tool

impl StructuralPartialEq for Tool