Struct metrics_prometheus::metric::Describable

pub struct Describable<Metric> { /* private fields */ }

prometheus metric with an ability to substitute its help description after registration in a prometheus::Registry.

Implementations

impl<M> Describable<M>

pub fn wrap(metric: M) -> Self

Wraps the provided prometheus metric into a Describable one.

pub fn only_description(help: impl Into<String>) -> Self

where M: Default,

Generates a Default prometheus metric with the provided help description.

pub fn map<Into>(self, into: impl FnOnce(M) -> Into) -> Describable<Into>

Maps the wrapped prometheus metric into another one, preserving the current overwritten help description (if any).

impl<M> Describable<Option<M>>

pub fn transpose(self) -> Option<Describable<M>>

Transposes this Describable Optional metric into an Option of a Describable metric.

Trait Implementations

impl<Metric: Clone> Clone for Describable<Metric>

fn clone(&self) -> Describable<Metric>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Collector for Describable<M>

where M: Collector,

fn desc(&self) -> Vec<&Desc>

Return descriptors for metrics.

fn collect(&self) -> Vec<MetricFamily>

Collect metrics.

impl<Metric: Debug> Debug for Describable<Metric>

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

Formats the value using the given formatter.

impl<Metric: Default> Default for Describable<Metric>

fn default() -> Describable<Metric>

Returns the “default value” for a type.