Struct metriken::MetricBuilder

pub struct MetricBuilder { /* private fields */ }

Builder for creating a dynamic metric.

This can be used to directly create a DynBoxedMetric or you can convert this builder into a MetricEntry for more advanced use cases.

Implementations

impl MetricBuilder

pub fn new(name: impl Into<Cow<'static, str>>) -> MetricBuilder

Create a new builder, starting with the metric name.

pub fn description(self, desc: impl Into<Cow<'static, str>>) -> MetricBuilder

Add a description of this metric.

pub fn metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> MetricBuilder

Add a new key-value metadata entry.

pub fn formatter( self, formatter: fn(_: &MetricEntry, _: Format) -> String, ) -> MetricBuilder

pub fn into_entry(self) -> MetricEntry

Convert this builder directly into a MetricEntry.

pub fn build<T>(self, metric: T) -> DynBoxedMetric<T>

where T: Metric,

Build a DynBoxedMetric for use with this builder.