Struct AsyncInstrumentBuilder

pub struct AsyncInstrumentBuilder<'a, I, M>
where
    I: AsyncInstrument<M>,
{ /* private fields */ }

Configuration for building an async instrument.

Implementations

impl<'a, I, M> AsyncInstrumentBuilder<'a, I, M>

where I: TryFrom<Self, Error = MetricsError> + AsyncInstrument<M>,

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 with_callback<F>(self, callback: F) -> Self

where F: Fn(&dyn AsyncInstrument<M>) + Send + Sync + 'static,

Set the callback to be called for this instrument.

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

Validate the instrument configuration and creates a new instrument.

pub fn init(self) -> I

Creates a new instrument.

Validate the instrument configuration and creates a new instrument.

Panics

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

Trait Implementations

impl<I, M> Debug for AsyncInstrumentBuilder<'_, I, M>

where I: AsyncInstrument<M>,

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

Formats the value using the given formatter.

impl TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64>> for ObservableCounter<f64>

type Error = MetricsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64>> for ObservableCounter<u64>

type Error = MetricsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64>> for ObservableGauge<f64>

type Error = MetricsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64>> for ObservableGauge<i64>

type Error = MetricsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64>> for ObservableGauge<u64>

type Error = MetricsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64>> for ObservableUpDownCounter<f64>

type Error = MetricsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64>> for ObservableUpDownCounter<i64>

type Error = MetricsError

The type returned in the event of a conversion error.

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

Performs the conversion.