Struct InstrumentBuilder

pub struct InstrumentBuilder<'a, T> { /* private fields */ }

Available on crate feature metrics only.

Configuration for building a sync instrument.

Implementations

impl<'a, T> InstrumentBuilder<'a, T>

where T: TryFrom<Self, Error = MetricsError>,

pub fn with_description<S: Into<Cow<'static, str>>>( self, description: S, ) -> Self

Set the description for this instrument

pub fn with_unit(self, unit: Unit) -> Self

Set the unit for this instrument.

Unit is case sensitive(kb is not the same as kB).

Unit must be:

• ASCII string
• No longer than 63 characters

pub fn try_init(self) -> Result<T>

Validate the instrument configuration and creates a new instrument.

pub fn init(self) -> T

Creates a new instrument.

This method reports configuration errors but still returns the instrument.

Panics

Panics if the instrument cannot be created. Use try_init if you want to handle errors.

Trait Implementations

impl<T> Debug for InstrumentBuilder<'_, T>

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

Formats the value using the given formatter.

impl TryFrom<InstrumentBuilder<'_, Counter<f64>>> for Counter<f64>

type Error = MetricsError

The type returned in the event of a conversion error.

fn try_from( builder: InstrumentBuilder<'_, Counter<f64>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InstrumentBuilder<'_, Counter<u64>>> for Counter<u64>

type Error = MetricsError

The type returned in the event of a conversion error.

fn try_from( builder: InstrumentBuilder<'_, Counter<u64>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InstrumentBuilder<'_, Histogram<f64>>> for Histogram<f64>

type Error = MetricsError

The type returned in the event of a conversion error.

fn try_from( builder: InstrumentBuilder<'_, Histogram<f64>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InstrumentBuilder<'_, Histogram<i64>>> for Histogram<i64>

type Error = MetricsError

The type returned in the event of a conversion error.

fn try_from( builder: InstrumentBuilder<'_, Histogram<i64>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InstrumentBuilder<'_, Histogram<u64>>> for Histogram<u64>

type Error = MetricsError

The type returned in the event of a conversion error.

fn try_from( builder: InstrumentBuilder<'_, Histogram<u64>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InstrumentBuilder<'_, UpDownCounter<f64>>> for UpDownCounter<f64>

type Error = MetricsError

The type returned in the event of a conversion error.

fn try_from( builder: InstrumentBuilder<'_, UpDownCounter<f64>>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InstrumentBuilder<'_, UpDownCounter<i64>>> for UpDownCounter<i64>

type Error = MetricsError

The type returned in the event of a conversion error.

fn try_from( builder: InstrumentBuilder<'_, UpDownCounter<i64>>, ) -> Result<Self, Self::Error>

Performs the conversion.