Enum CachegrindMetrics

#[non_exhaustive]
pub enum CachegrindMetrics {
    Default,
    CacheMisses,
    CacheMissRates,
    CacheHits,
    CacheHitRates,
    CacheSim,
    BranchSim,
    All,
    None,
    SingleEvent(CachegrindMetric),
}

Available on crate feature api only.

A collection of groups of CachegrindMetrics

The members of each group are fully documented in the docs of each variant of this enum

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

The default group contains all metrics except the CachegrindMetrics::CacheMisses, CachegrindMetrics::CacheMissRates, CachegrindMetrics::CacheHitRates and EventKind::Dr, EventKind::Dw. More specifically, the following event kinds and groups in this order:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::Ir.into(),
    CachegrindMetrics::CacheHits,
    CachegrindMetric::TotalRW.into(),
    CachegrindMetric::EstimatedCycles.into(),
    CachegrindMetrics::BranchSim,
];

CacheMisses

The CacheMisses produced by --cache-sim=yes contain the following CachegrindMetrics in this order:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::I1mr.into(),
    CachegrindMetric::D1mr.into(),
    CachegrindMetric::D1mw.into(),
    CachegrindMetric::ILmr.into(),
    CachegrindMetric::DLmr.into(),
    CachegrindMetric::DLmw.into(),
];

CacheMissRates

The cache miss rates calculated from the CallgrindMetrics::CacheMisses produced by --cache-sim:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::I1MissRate.into(),
    CachegrindMetric::LLiMissRate.into(),
    CachegrindMetric::D1MissRate.into(),
    CachegrindMetric::LLdMissRate.into(),
    CachegrindMetric::LLMissRate.into(),
];

CacheHits

CacheHits are iai-callgrind specific and calculated from the metrics produced by --cache-sim=yes in this order:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::L1hits.into(),
    CachegrindMetric::LLhits.into(),
    CachegrindMetric::RamHits.into(),
];

CacheHitRates

The cache hit rates calculated from the CachegrindMetrics::CacheHits:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::L1HitRate.into(),
    CachegrindMetric::LLHitRate.into(),
    CachegrindMetric::RamHitRate.into(),
];

CacheSim

All metrics produced by --cache-sim=yes including the iai-callgrind specific metrics CachegrindMetric::L1hits, CachegrindMetric::LLhits, CachegrindMetric::RamHits, CachegrindMetric::TotalRW, CachegrindMetric::EstimatedCycles, CachegrindMetrics::CacheMissRates and CachegrindMetrics::CacheHitRates in this order:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::Dr.into(),
    CachegrindMetric::Dw.into(),
    CachegrindMetrics::CacheMisses,
    CachegrindMetrics::CacheMissRates,
    CachegrindMetrics::CacheHits,
    CachegrindMetrics::CacheHitRates,
    CachegrindMetric::TotalRW.into(),
    CachegrindMetric::EstimatedCycles.into(),
];

BranchSim

The metrics produced by --branch-sim=yes in this order:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::Bc.into(),
    CachegrindMetric::Bcm.into(),
    CachegrindMetric::Bi.into(),
    CachegrindMetric::Bim.into(),
];

All

All possible CachegrindMetrics in this order:

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

let metrics: Vec<CachegrindMetrics> = vec![
    CachegrindMetric::Ir.into(),
    CachegrindMetrics::CacheSim,
    CachegrindMetrics::BranchSim,
];

None

Selection of no CachegrindMetric at all

SingleEvent(CachegrindMetric)

Specify a single CachegrindMetric.

Note that CachegrindMetric implements the necessary traits to convert to the CachegrindMetrics::SingleEvent variant.

Examples

use iai_callgrind::{CachegrindMetric, CachegrindMetrics};

assert_eq!(
    CachegrindMetrics::SingleEvent(CachegrindMetric::Ir),
    CachegrindMetric::Ir.into()
);

Trait Implementations

impl Clone for CachegrindMetrics

fn clone(&self) -> CachegrindMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CachegrindMetrics

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

Formats the value using the given formatter.

impl Default for CachegrindMetrics

fn default() -> CachegrindMetrics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CachegrindMetrics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CachegrindMetric> for CachegrindMetrics

fn from(value: CachegrindMetric) -> Self

Converts to this type from the input type.

impl From<CachegrindMetrics> for IndexSet<CachegrindMetric>

Available on crate feature runner only.

fn from(value: CachegrindMetrics) -> Self

Converts to this type from the input type.

impl FromStr for CachegrindMetrics

Available on crate feature runner only.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for CachegrindMetrics

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CachegrindMetrics

impl StructuralPartialEq for CachegrindMetrics