Skip to main content

CounterDelta

Enum CounterDelta 

Source
pub enum CounterDelta {
    FirstSample,
    Advanced {
        delta: u64,
        elapsed: Duration,
        wrapped: bool,
    },
    Reset,
}
Expand description

What one counter reading means relative to the previous one.

Returned by CounterTracker::observe for callers that need the raw movement — running totals such as NetworkSnapshot::since_launch accumulate deltas rather than rates. Callers that only want a rate use CounterTracker::rate.

Variants§

§

FirstSample

There was no previous reading, so no delta exists yet.

§8.2 and §26: the first sample of delta-based data is warming up, and it is emphatically not zero.

§

Advanced

A validated, non-negative movement over a measured monotonic interval.

Fields

§delta: u64

How far the counter moved forward.

§elapsed: Duration

The monotonic interval the movement happened in.

May be Duration::ZERO when two readings share a timestamp. The delta is still valid as a total in that case, but no rate can be derived from it (§8.1).

§wrapped: bool

Whether the movement was reconstructed from a known-width wrap.

Exposed so collectors can record a wrap as a health issue instead of silently trusting a reconstructed delta.

§

Reset

The counter moved backwards in a way no known width explains.

The tracker has already re-baselined on the offending reading, so the next reading produces a valid delta rather than a second reset (§8.2).

Implementations§

Source§

impl CounterDelta

Source

pub fn rate(self) -> MetricState<Rate>

The rate this delta represents, as a publishable metric state.

Source

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

How far the counter moved, if this reading produced a usable movement.

Returns None for the first sample and for a reset, so a caller accumulating a running total cannot add an invalid delta to it.

Source

pub const fn wrapped(self) -> bool

Whether this reading was reconstructed from a known-width wraparound.

Trait Implementations§

Source§

impl Clone for CounterDelta

Source§

fn clone(&self) -> CounterDelta

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CounterDelta

Source§

impl Debug for CounterDelta

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CounterDelta

Source§

impl PartialEq for CounterDelta

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CounterDelta

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.