Struct ore::metrics::delete_on_drop::DeleteOnDropGauge

pub struct DeleteOnDropGauge<'a, P, L> where
    P: Atomic,
    L: PromLabelsExt<'a>,  {
    inner: GenericGauge<P>,
    labels: L,
    vec: GenericGaugeVec<P>,
    _phantom: &'a PhantomData<()>,
}

This is supported on crate feature metrics only.

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

Fields

inner: GenericGauge<P>

labels: L

vec: GenericGaugeVec<P>

_phantom: &'a PhantomData<()>

Implementations

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

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

Methods from Deref<Target = GenericGauge<P>>

pub fn fq_name(&self) -> &str

The fully qualified name for this gauge

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

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

Set the gauge to an arbitrary value.

pub fn inc(&self)

Increase the gauge by 1.

pub fn dec(&self)

Decrease the gauge by 1.

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

Add the given value to the gauge. (The value can be negative, resulting in a decrement of the gauge.)

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

Subtract the given value from the gauge. (The value can be negative, resulting in an increment of the gauge.)

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

Return the gauge value.

Trait Implementations

impl<'a, P: Debug, L: Debug> Debug for DeleteOnDropGauge<'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 DeleteOnDropGauge<'a, P, L> where
    P: Atomic,
    L: PromLabelsExt<'a>, 

type Target = GenericGauge<P>

The resulting type after dereferencing.

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

Dereferences the value.

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

fn drop(&mut self)

Executes the destructor for this type.