Enum DhatMetric

pub enum DhatMetric {
    TotalUnits,
    TotalEvents,
    TotalBytes,
    TotalBlocks,
    AtTGmaxBytes,
    AtTGmaxBlocks,
    AtTEndBytes,
    AtTEndBlocks,
    ReadsBytes,
    WritesBytes,
    TotalLifetimes,
    MaximumBytes,
    MaximumBlocks,
}

Available on crate feature api only.

The metrics collected by DHAT

Variants

TotalUnits

In ad-hoc mode, Total units measured over the entire execution

TotalEvents

Total ad-hoc events over the entire execution

TotalBytes

Total bytes allocated over the entire execution

TotalBlocks

Total heap blocks allocated over the entire execution

AtTGmaxBytes

The bytes alive at t-gmax, the time when the heap size reached its global maximum

AtTGmaxBlocks

The blocks alive at t-gmax

AtTEndBytes

The amount of bytes at the end of the execution.

This is the amount of bytes which were not explicitly freed.

AtTEndBlocks

The amount of blocks at the end of the execution.

This is the amount of heap blocks which were not explicitly freed.

ReadsBytes

The amount of bytes read during the entire execution

WritesBytes

The amount of bytes written during the entire execution

TotalLifetimes

The total lifetimes of all heap blocks allocated

MaximumBytes

The maximum amount of bytes

MaximumBlocks

The maximum amount of heap blocks

Trait Implementations

impl Clone for DhatMetric

fn clone(&self) -> DhatMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DhatMetric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DhatMetric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DhatMetric

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

Formats the value using the given formatter.

impl From<DhatMetric> for DhatMetrics

fn from(value: DhatMetric) -> Self

Converts to this type from the input type.

impl FromStr for DhatMetric

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 Hash for DhatMetric

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for DhatMetric

type Iterator = DhatMetricIter

fn iter() -> DhatMetricIter

impl JsonSchema for DhatMetric

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for DhatMetric

fn eq(&self, other: &DhatMetric) -> 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 RegressionConfig<DhatMetric> for DhatRegressionConfig

Available on crate feature runner only.

fn check( &self, metrics_summary: &MetricsSummary<DhatMetric>, ) -> Vec<ToolRegression>

Check the MetricsSummary for regressions.

fn get_soft_limits(&self) -> &[(DhatMetric, f64)]

Return the soft limits

fn get_hard_limits(&self) -> &[(DhatMetric, Metric)]

Return the hard limits

fn check_and_print( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<ToolRegression>

Check for regressions and print them if present

fn check_regressions( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<RegressionMetrics<T>>

Check for regressions and return the RegressionMetrics

impl Serialize for DhatMetric

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Summarize for DhatMetric

Available on crate feature runner only.

fn summarize(_: &mut Cow<'_, Metrics<Self>>)

Calculate the derived metrics if any

impl TypeChecker for DhatMetric

Available on crate feature runner only.

fn is_int(&self) -> bool

Return true if the metric kind is a Metric::Int

fn is_float(&self) -> bool

Return true if the metric kind is a Metric::Float

fn verify_metric(&self, metric: Metric) -> bool

Return true if the Metric has the expected metric type

impl Copy for DhatMetric

impl Eq for DhatMetric

impl StructuralPartialEq for DhatMetric