Struct Generational

pub struct Generational<T> { /* private fields */ }

Available on crate features registry and recency only.

Generation tracking for a metric.

Holds a generic interior value, and provides way to access the value such that each access increments the “generation” of the value. This provides a means to understand if the value has been updated since the last time it was observed.

For example, if a gauge was observed to be X at one point in time, and then observed to be X again at a later point in time, it could have changed in between the two observations. It also may not have changed, and thus Generational provides a way to determine if either of these events occurred.

Implementations

impl<T> Generational<T>

pub fn get_inner(&self) -> &T

Gets a reference to the inner value.

pub fn get_generation(&self) -> Generation

Gets the current generation.

pub fn with_increment<F, V>(&self, f: F) -> V

where F: Fn(&T) -> V,

Acquires a reference to the inner value, and increments the generation.

Trait Implementations

impl<T: Clone> Clone for Generational<T>

fn clone(&self) -> Generational<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> CounterFn for Generational<T>

where T: CounterFn,

fn increment(&self, value: u64)

Increments the counter by the given amount.

fn absolute(&self, value: u64)

Sets the counter to at least the given amount.

impl<T: Debug> Debug for Generational<T>

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

Formats the value using the given formatter.

impl<T> From<Generational<T>> for Counter

where T: CounterFn + Send + Sync + 'static,

fn from(inner: Generational<T>) -> Self

Converts to this type from the input type.

impl<T> From<Generational<T>> for Gauge

where T: GaugeFn + Send + Sync + 'static,

fn from(inner: Generational<T>) -> Self

Converts to this type from the input type.

impl<T> From<Generational<T>> for Histogram

where T: HistogramFn + Send + Sync + 'static,

fn from(inner: Generational<T>) -> Self

Converts to this type from the input type.

impl<T> GaugeFn for Generational<T>

where T: GaugeFn,

fn increment(&self, value: f64)

Increments the gauge by the given amount.

fn decrement(&self, value: f64)

Decrements the gauge by the given amount.

fn set(&self, value: f64)

Sets the gauge to the given amount.

impl<T> HistogramFn for Generational<T>

where T: HistogramFn,

fn record(&self, value: f64)

Records a value into the histogram.

fn record_many(&self, value: f64, count: usize)

Records a value into the histogram multiple times.