Struct OutputFormat

pub struct OutputFormat {
    pub cachegrind: IndexSet<CachegrindMetric>,
    pub callgrind: IndexSet<EventKind>,
    pub dhat: IndexSet<DhatMetric>,
    pub drd: IndexSet<ErrorMetric>,
    pub helgrind: IndexSet<ErrorMetric>,
    pub kind: OutputFormatKind,
    pub memcheck: IndexSet<ErrorMetric>,
    pub show_grid: bool,
    pub show_intermediate: bool,
    pub tolerance: Option<f64>,
    pub truncate_description: Option<usize>,
}

Available on crate feature runner only.

The OutputFormat of the Iai-Callgrind terminal output

Fields

cachegrind: IndexSet<CachegrindMetric>

The Cachegrind metrics to show

callgrind: IndexSet<EventKind>

The Callgrind metrics to show

dhat: IndexSet<DhatMetric>

The DHAT metrics to show

drd: IndexSet<ErrorMetric>

The DRD error metrics to show

helgrind: IndexSet<ErrorMetric>

The Helgrind error metrics to show

kind: OutputFormatKind

The OutputFormatKind

memcheck: IndexSet<ErrorMetric>

The Memcheck error metrics to show

show_grid: bool

Show a grid instead of blank spaces

show_intermediate: bool

Show intermediate metrics output or just the total

tolerance: Option<f64>

Don’t show differences within the tolerance margin

truncate_description: Option<usize>

If present truncate the description to this amount of bytes

Implementations

impl OutputFormat

pub fn is_default(&self) -> bool

Return true if the OutputFormat is the default format

pub fn is_json(&self) -> bool

Return true if the OutputFormat is json

pub fn update(&mut self, tool: Option<&Tool>)

Update the output format from the Tool if present

pub fn update_from_meta(&mut self, meta: &Metadata)

Update the output format with data from command-line arguments in Metadata

Trait Implementations

impl Clone for OutputFormat

fn clone(&self) -> OutputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputFormat

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

Formats the value using the given formatter.

impl Default for OutputFormat

fn default() -> Self

Returns the “default value” for a type.

impl From<OutputFormat> for OutputFormat

fn from(value: OutputFormat) -> Self

Converts to this type from the input type.

impl PartialEq for OutputFormat

fn eq(&self, other: &OutputFormat) -> 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 StructuralPartialEq for OutputFormat