Struct open_metrics_client::metrics::counter::Counter

pub struct Counter<A> { /* fields omitted */ }

Open Metrics Counter to measure discrete events.

Single monotonically increasing value metric.

let counter = Counter::<AtomicU64>::new();
counter.inc();

Implementations

impl<A: Atomic> Counter<A>

pub fn new() -> Self

pub fn inc(&self) -> A::Number

pub fn inc_by(&self, v: A::Number) -> A::Number

pub fn get(&self) -> A::Number

pub fn inner(&self) -> &A

Exposes the inner atomic type.

This should only be used for advanced use-cases which are not directly supported by the library.

The caller of this function has to uphold the property of an Open Metrics counter namely that the value is monotonically increasing, i.e. either stays the same or increases.

Trait Implementations

impl<A> Clone for Counter<A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Default for Counter<A> where
    A: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<A> EncodeMetric for Counter<A> where
    A: Atomic,
    <A as Atomic>::Number: Encode, 

fn encode(&self, encoder: Encoder<'_, '_>) -> Result<(), Error>

fn metric_type(&self) -> MetricType

impl<A> TypedMetric for Counter<A>

const TYPE: MetricType