Struct Dhat

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

Available on crate feature default only.

The configuration for Dhat

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

Example

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

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

Implementations

impl Dhat

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

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

Create a new Callgrind configuration with initial command-line arguments

See also Callgrind::args and Dhat::args

Examples

use iai_callgrind::Dhat;

let config = Dhat::with_args(["mode=ad-hoc"]);

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

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

let config = Dhat::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::Dhat;

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

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

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

Customize the format of the dhat output

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

Examples

use iai_callgrind::{Dhat, DhatMetric};

let config = Dhat::default().format([DhatMetric::TotalBytes, DhatMetric::AtTGmaxBytes]);

Trait Implementations

impl AsRef<Tool> for Dhat

fn as_ref(&self) -> &InternalTool

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

impl Clone for Dhat

fn clone(&self) -> Dhat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dhat

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

Formats the value using the given formatter.

impl Default for Dhat

fn default() -> Self

Returns the “default value” for a type.

impl From<&Dhat> for InternalTool

fn from(value: &Dhat) -> Self

Converts to this type from the input type.

impl From<&mut Dhat> for InternalTool

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

Converts to this type from the input type.

impl From<Dhat> for InternalTool

fn from(value: Dhat) -> Self

Converts to this type from the input type.