Struct Metrics

pub struct Metrics<K: Hash + Eq>(pub IndexMap<K, u64>);

Available on crate feature runner only.

The Metrics backed by an indexmap::IndexMap

The insertion order is preserved.

Tuple Fields

0: IndexMap<K, u64>

Implementations

impl Metrics<EventKind>

pub fn make_summary(&mut self) -> Result<()>

Calculate and add derived summary events (i.e. estimated cycles) in-place

Additional calls to this function will overwrite the metrics for derived summary events.

Errors

If the necessary cache simulation events (when running callgrind with –cache-sim) were not present.

pub fn is_summarized(&self) -> bool

Return true if costs are already summarized

This method just probes for EventKind::EstimatedCycles to detect the summarized state.

pub fn can_summarize(&self) -> bool

Return true if costs can be summarized

This method probes for EventKind::I1mr which is present if callgrind was run with the cache simulation (--cache-sim=yes) enabled.

impl<K: Hash + Eq + Display + Clone> Metrics<K>

pub fn empty() -> Self

Return empty Metrics

pub fn with_metric_kinds<T>(kinds: T) -> Self

where T: IntoIterator<Item = (K, u64)>,

pub fn add_iter_str<I, T>(&mut self, iter: T) -> Result<()>

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

Add metrics from an iterator over strings

Adding metrics stops as soon as there are no more keys in this Metrics or no more values in the iterator. This property is especially important for the metrics from the callgrind output files. From the documentation of the callgrind format:

If a cost line specifies less event counts than given in the “events” line, the rest is assumed to be zero.

Errors

If one of the strings in the iterator is not parsable as u64

pub fn add(&mut self, other: &Self)

Sum this Metric with another Metric

Do not use this method if both Metrics can differ in their keys order.

pub fn metric_by_index(&self, index: usize) -> Option<u64>

Return the metric of the kind at index (of insertion order) if present

This operation is O(1)

pub fn metric_by_kind(&self, kind: &K) -> Option<u64>

Return the metric of the kind if present

This operation is O(1)

pub fn try_metric_by_kind(&self, kind: &K) -> Result<u64>

Return the metric kind or an error

Errors

If the metric kind is not present

pub fn metric_kinds(&self) -> Vec<K>

pub fn metric_kinds_union<'a>(&'a self, other: &'a Self) -> IndexSet<&'a K>

Create the union set of the keys of this and another Metrics

The order of the keys is preserved. New keys from the other Metrics are appended in their original order.

pub fn iter(&self) -> Iter<'_, K, u64>

Return an iterator over the metrics in insertion order

pub fn is_empty(&self) -> bool

Return true if there are no metrics present

pub fn insert(&mut self, key: K, value: u64) -> Option<u64>

Insert a single metric

If an equivalent key already exists in the map: the key remains and retains in its place in the order, its corresponding value is updated with value, and the older value is returned inside Some(_).

If no equivalent key existed in the map: the new key-value pair is inserted, last in order, and None is returned.

pub fn insert_all(&mut self, entries: &[(K, u64)])

Insert all metrics

See also Metrics::insert

Trait Implementations

impl<K: Clone + Hash + Eq> Clone for Metrics<K>

fn clone(&self) -> Metrics<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Hash + Eq> Debug for Metrics<K>

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

Formats the value using the given formatter.

impl<'de, K> Deserialize<'de> for Metrics<K>

where K: Deserialize<'de> + Hash + Eq,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I, K: Hash + Eq + From<I>> FromIterator<I> for Metrics<K>

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = I>,

Creates a value from an iterator.

impl<'a, K: Hash + Eq + Display + Clone> IntoIterator for &'a Metrics<K>

type Item = (&'a K, &'a u64)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, u64>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Hash + Eq + JsonSchema> JsonSchema for Metrics<K>

fn schema_name() -> String

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(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<K: PartialEq + Hash + Eq> PartialEq for Metrics<K>

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

where K: Serialize + Hash + Eq,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Metrics<EventKind>> for CacheSummary

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Metrics) -> Result<Self, Self::Error>

Performs the conversion.

impl<K: Eq + Hash + Eq> Eq for Metrics<K>

impl<K: Hash + Eq> StructuralPartialEq for Metrics<K>