Struct ore::metrics::delete_on_drop::DeleteOnDropCounter

pub struct DeleteOnDropCounter<'a, P, L> where
    P: Atomic,
    L: PromLabelsExt<'a>,  {
    inner: GenericCounter<P>,
    labels: L,
    vec: GenericCounterVec<P>,
    _phantom: &'a PhantomData<()>,
}

This is supported on crate feature metrics only.

A GenericCounter wrapper that deletes its labels from the vec when it is dropped

It adds a method to create a concrete metric from the vector that gets removed from the vector when the concrete metric is dropped.

Fields

inner: GenericCounter<P>

labels: L

vec: GenericCounterVec<P>

_phantom: &'a PhantomData<()>

Implementations

impl<'a, P, L> DeleteOnDropCounter<'a, P, L> where
    P: Atomic,
    L: PromLabelsExt<'a>, 

fn from_metric_vector(vec: GenericCounterVec<P>, labels: L) -> Self

Methods from Deref<Target = GenericCounter<P>>

pub fn fq_name(&self) -> &str

The fully qualified name for this counter

This is the name with no labels, and corresponds to desc().fq_name on the Collector trait.

pub fn inc_by(&self, v: <P as Atomic>::T)

Increase the given value to the counter.

Panics

Panics in debug build if the value is < 0.

pub fn inc(&self)

Increase the counter by 1.

pub fn get(&self) -> <P as Atomic>::T

Return the counter value.

pub fn reset(&self)

Restart the counter, resetting its value back to 0.

pub fn local(&self) -> GenericLocalCounter<P>

Return a GenericLocalCounter for single thread usage.

Trait Implementations

impl<'a, P: Debug, L: Debug> Debug for DeleteOnDropCounter<'a, P, L> where
    P: Atomic,
    L: PromLabelsExt<'a>, 

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

Formats the value using the given formatter.

impl<'a, P, L> Deref for DeleteOnDropCounter<'a, P, L> where
    P: Atomic,
    L: PromLabelsExt<'a>, 

type Target = GenericCounter<P>

The resulting type after dereferencing.

fn deref(&self) -> &GenericCounter<P>

Dereferences the value.

impl<'a, P, L> Drop for DeleteOnDropCounter<'a, P, L> where
    P: Atomic,
    L: PromLabelsExt<'a>, 

fn drop(&mut self)

Executes the destructor for this type.