Trait EncodeMetric 

pub trait EncodeMetric {
    // Required methods
    fn encode(&self, encoder: MetricEncoder<'_>) -> Result<(), Error>;
    fn metric_type(&self) -> MetricType;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

Trait implemented by each metric type, e.g. Counter, to implement its encoding in the OpenMetric text format.

Required Methods

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.

Provided Methods

fn is_empty(&self) -> bool

Check if the metric is empty.

An empty metric is a metric that has no data to encode, and thus should not have any descriptor in the final output.

By default, this returns false, ensuring the metric and its description is always encoded.

Trait Implementations

impl EncodeMetric for Box<dyn EncodeMetric>

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.

fn is_empty(&self) -> bool

Check if the metric is empty.

Implementations on Foreign Types

impl EncodeMetric for Box<dyn EncodeMetric>

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

fn metric_type(&self) -> MetricType

Implementors

impl EncodeMetric for Histogram

impl<N> EncodeMetric for ConstCounter<N>

where N: EncodeCounterValue,

impl<N> EncodeMetric for ConstGauge<N>

where N: EncodeGaugeValue,

impl<N, A> EncodeMetric for Counter<N, A>

where N: EncodeCounterValue, A: Atomic<N>,

impl<N, A> EncodeMetric for Gauge<N, A>

where N: EncodeGaugeValue, A: Atomic<N>,

impl<S> EncodeMetric for Info<S>

where S: Clone + Hash + Eq + EncodeLabelSet,

impl<S, M, C> EncodeMetric for Family<S, M, C>

where S: Clone + Hash + Eq + EncodeLabelSet, M: EncodeMetric + TypedMetric, C: MetricConstructor<M>,

impl<S, N, A> EncodeMetric for CounterWithExemplar<S, N, A>

where S: EncodeLabelSet, N: EncodeCounterValue + EncodeExemplarValue + Clone, A: Atomic<N>,

impl<S: EncodeLabelSet> EncodeMetric for HistogramWithExemplars<S>