Struct MetricsSummary

pub struct MetricsSummary<K: Hash + Eq = EventKind>(/* private fields */);

Available on crate feature runner only.

The MetricsSummary contains all differences between two tool run segments

Implementations

impl<K> MetricsSummary<K>

where K: Hash + Eq + Summarize + Display + Clone,

pub fn new(metrics: EitherOrBoth<Metrics<K>>) -> Self

Create a new MetricsSummary calculating the differences between new and old (if any) Metrics

Panics

If one of the Metrics is empty

pub fn diff_by_kind(&self, metric_kind: &K) -> Option<&MetricsDiff>

Try to return a MetricsDiff for the specified MetricKind

pub fn all_diffs(&self) -> impl Iterator<Item = (&K, &MetricsDiff)>

Return an iterator over all MetricsDiffs

pub fn extract_costs(&self) -> EitherOrBoth<Metrics<K>>

Extract the Metrics from this summary

This is the exact reverse operation to MetricsSummary::new

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

Sum up another MetricsSummary with this one

If a MetricsDiff is not present in this summary but in the other, it is added to this summary.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<K> Default for MetricsSummary<K>

where K: Hash + Eq,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K> Deserialize<'de> for MetricsSummary<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<K> JsonSchema for MetricsSummary<K>

where K: JsonSchema + Hash + Eq,

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<K: PartialEq + Hash + Eq> PartialEq for MetricsSummary<K>

fn eq(&self, other: &MetricsSummary<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 MetricsSummary<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<K: Hash + Eq> StructuralPartialEq for MetricsSummary<K>