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. Saturating summary of observations in one consumer-selected unit.

Count and total saturate independently at u64::MAX. Treat either counter at that value as unavailable for exact interval arithmetic, including when reached exactly. Latest and maximum remain individual observations after saturation. Empty and measured zero are distinct states.

Consumers establish identity and reset boundaries before comparing snapshots. The summary does not decide whether observations overlap or are additive.

Implementations

impl MeasurementSummary

pub const EMPTY: MeasurementSummary

Empty summary, with no latest or maximum observation.

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

Record one completed observation, including zero.

Every observation must use the same unit as earlier observations.

pub const fn samples(self) -> u64

Number of completed samples, saturating independently of the total.

pub const fn total(self) -> u64

Sum of all observations, saturating independently of the sample count.

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

Integer mean in the observation’s unit, rounded down, or None if empty.

Errors

Returns MeasurementMeanError when either counter is at u64::MAX, including an exactly reached cap. Uses the same contract as checked_mean.

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

Latest observation, or None when no sample has been recorded.

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

Largest observation, or None when no sample has been recorded.

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