Struct MeasurementSummary 

pub struct MeasurementSummary { /* private fields */ }

Canonical shared arithmetic for local diagnostic summaries and distributions.

Re-exported so callers can name returned summaries without selecting a separate Metrics dependency. This is the shared type, with no local wrapper or arithmetic. Ordered observations with a mergeable aggregate and a separate latest value.

Count and total saturate independently, tracking actual overflow. An exactly reached numeric cap remains exact; inspect the aggregate’s saturation flags before using raw counts/totals for exact arithmetic. Latest and maximum remain individual observations after overflow. Empty and measured zero are distinct. Consumers own units, identity, ordering and reset boundaries.

Implementations

impl MeasurementSummary

pub const EMPTY: MeasurementSummary

Empty summary, with no latest or maximum observation.

pub const fn from_parts( aggregate: MeasurementAggregate, latest: Option<u64>, ) -> Result<MeasurementSummary, MeasurementStateError>

Restore an admitted aggregate and its latest ordered observation.

The caller establishes identity and ordering; this validates numeric fields.

Errors

Rejects absent/nonempty latest values, values above the maximum and observations inconsistent with the aggregate’s exact total. With an exact count, the other observations cannot contribute more than their maximum.

pub const fn record(&mut self, value: u64)

Record one completed observation, including zero, in the existing unit.

pub const fn aggregate(self) -> MeasurementAggregate

Mergeable count/total/maximum snapshot without observation ordering.

pub const fn samples(self) -> u64

Sample count, clipped at u64::MAX; saturation is in Self::aggregate.

pub const fn total(self) -> u128

Observation total, clipped at u128::MAX; saturation is in Self::aggregate.

pub const fn mean(self) -> Result<Option<u128>, MeasurementMeanError>

Floor-rounded mean, or None when empty. An exactly reached cap is valid.

Errors

Returns MeasurementMeanError on actual count or total overflow.

pub const fn scaled_mean( self, scale: u64, ) -> Result<Option<u128>, MeasurementMeanError>

Compute floor(total * scale / samples), retaining fractional information.

Uses the aggregate’s checked projection; a scale of ten reports tenths. Empty remains None, and scale zero does not conceal actual overflow.

Errors

Returns MeasurementMeanError for inexact counts/totals or a failed scaled projection, with the same precedence as the aggregate.

pub const fn latest(self) -> Option<u64>

Latest observation, or None when empty. Summaries cannot be merged.

pub const fn maximum(self) -> Option<u64>

Largest observation, or None when empty, including after overflow.

Trait Implementations

impl Clone for MeasurementSummary

fn clone(&self) -> MeasurementSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MeasurementSummary

impl Debug for MeasurementSummary

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

Formats the value using the given formatter.

impl Default for MeasurementSummary

fn default() -> MeasurementSummary

Returns the “default value” for a type.

impl Eq for MeasurementSummary

impl PartialEq for MeasurementSummary

fn eq(&self, other: &MeasurementSummary) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MeasurementSummary