Struct prometheus_client::metrics::family::ConstFamily

pub struct ConstFamily<I>(_);

As a Family, but constant, meaning it cannot change once created.

Needed for advanced use-cases, e.g. in combination with Collector.

Note that a ConstFamily, given that it is based on an Iterator, can only be EncodeMetric::encoded once. While consecutive EncodeMetric::encode calls won’t panic, they won’t return any metrics as the provided Iterator will return Iterator::next None. Thus you should not return the same ConstFamily in more than one Collector::collect calls.

Implementations

impl<I> ConstFamily<I>

pub fn new(iter: I) -> Self

Creates a new ConstFamily.

Trait Implementations

impl<I: Debug> Debug for ConstFamily<I>

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

Formats the value using the given formatter.

impl<I: Default> Default for ConstFamily<I>

fn default() -> ConstFamily<I>

Returns the “default value” for a type.

impl<S: EncodeLabelSet, M: EncodeMetric + TypedMetric, I: Iterator<Item = (S, M)>> EncodeMetric for ConstFamily<I>

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

Encode the given instance in the OpenMetrics text encoding.

fn metric_type(&self) -> MetricType

The OpenMetrics metric type of the instance.