Struct metriken::Counter

pub struct Counter(/* private fields */);

A counter. Can be incremented or added to.

In case of overflow the counter will wrap around. However, internally it uses an unsigned 64-bit integer so for most use cases this should be unlikely.

Example

#[metric(name = "my.custom.metric")]
static MY_COUNTER: Counter = Counter::new();

fn a_method() {
    MY_COUNTER.increment();
    // ...
}

Implementations

impl Counter

pub const fn new() -> Self

Create a counter initialized to 0.

pub const fn with_value(value: u64) -> Self

Create a counter initialized to value.

pub fn increment(&self) -> u64

pub fn add(&self, value: u64) -> u64

pub fn value(&self) -> u64

pub fn set(&self, value: u64) -> u64

pub fn reset(&self) -> u64

Trait Implementations

impl Debug for Counter

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

Formats the value using the given formatter.

impl Default for Counter

fn default() -> Counter

Returns the “default value” for a type.

impl Metric for Counter

fn as_any(&self) -> Option<&dyn Any>

Get the current metric as an Any instance. This is meant to allow custom processing for known metric types.

fn value(&self) -> Option<Value<'_>>

Get the value of the current metric, should it be enabled.

fn is_enabled(&self) -> bool

Indicate whether this metric has been set up.