Struct rama::telemetry::opentelemetry::metrics::AsyncInstrumentBuilder
#[non_exhaustive]pub struct AsyncInstrumentBuilder<'a, I, M>where
I: AsyncInstrument<M>,{
pub instrument_provider: &'a dyn InstrumentProvider,
pub name: Cow<'static, str>,
pub description: Option<Cow<'static, str>>,
pub unit: Option<Cow<'static, str>>,
pub callbacks: Vec<Box<dyn Fn(&dyn AsyncInstrument<M>) + Sync + Send>>,
/* private fields */
}
Expand description
Configuration for building an async instrument.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.instrument_provider: &'a dyn InstrumentProvider
Instrument provider is used to create the instrument.
name: Cow<'static, str>
Name of the instrument.
description: Option<Cow<'static, str>>
Description of the instrument.
unit: Option<Cow<'static, str>>
Unit of the instrument.
callbacks: Vec<Box<dyn Fn(&dyn AsyncInstrument<M>) + Sync + Send>>
Callbacks to be called for this instrument.
Implementations§
§impl<'a, I, M> AsyncInstrumentBuilder<'a, I, M>
impl<'a, I, M> AsyncInstrumentBuilder<'a, I, M>
pub fn with_description<S>(
self,
description: S,
) -> AsyncInstrumentBuilder<'a, I, M>
pub fn with_description<S>( self, description: S, ) -> AsyncInstrumentBuilder<'a, I, M>
Set the description for this instrument
pub fn with_unit<S>(self, unit: S) -> AsyncInstrumentBuilder<'a, I, M>
pub fn with_unit<S>(self, unit: S) -> AsyncInstrumentBuilder<'a, I, M>
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) -> AsyncInstrumentBuilder<'a, I, M>
pub fn with_callback<F>(self, callback: F) -> AsyncInstrumentBuilder<'a, I, M>
Set the callback to be called for this instrument.
pub fn try_init(self) -> Result<I, MetricsError>
pub fn try_init(self) -> Result<I, MetricsError>
Validate the instrument configuration and creates a new instrument.
Trait Implementations§
§impl<I, M> Debug for AsyncInstrumentBuilder<'_, I, M>where
I: AsyncInstrument<M>,
impl<I, M> Debug for AsyncInstrumentBuilder<'_, I, M>where
I: AsyncInstrument<M>,
§impl TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64>> for ObservableCounter<f64>
impl TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64>> for ObservableCounter<f64>
§type Error = MetricsError
type Error = MetricsError
The type returned in the event of a conversion error.
§fn try_from(
builder: AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64>,
) -> Result<ObservableCounter<f64>, <ObservableCounter<f64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64>>>::Error>
fn try_from( builder: AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64>, ) -> Result<ObservableCounter<f64>, <ObservableCounter<f64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<f64>, f64>>>::Error>
Performs the conversion.
§impl TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64>> for ObservableCounter<u64>
impl TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64>> for ObservableCounter<u64>
§type Error = MetricsError
type Error = MetricsError
The type returned in the event of a conversion error.
§fn try_from(
builder: AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64>,
) -> Result<ObservableCounter<u64>, <ObservableCounter<u64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64>>>::Error>
fn try_from( builder: AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64>, ) -> Result<ObservableCounter<u64>, <ObservableCounter<u64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableCounter<u64>, u64>>>::Error>
Performs the conversion.
§impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64>> for ObservableGauge<f64>
impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64>> for ObservableGauge<f64>
§type Error = MetricsError
type Error = MetricsError
The type returned in the event of a conversion error.
§fn try_from(
builder: AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64>,
) -> Result<ObservableGauge<f64>, <ObservableGauge<f64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64>>>::Error>
fn try_from( builder: AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64>, ) -> Result<ObservableGauge<f64>, <ObservableGauge<f64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<f64>, f64>>>::Error>
Performs the conversion.
§impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64>> for ObservableGauge<i64>
impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64>> for ObservableGauge<i64>
§type Error = MetricsError
type Error = MetricsError
The type returned in the event of a conversion error.
§fn try_from(
builder: AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64>,
) -> Result<ObservableGauge<i64>, <ObservableGauge<i64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64>>>::Error>
fn try_from( builder: AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64>, ) -> Result<ObservableGauge<i64>, <ObservableGauge<i64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<i64>, i64>>>::Error>
Performs the conversion.
§impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64>> for ObservableGauge<u64>
impl TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64>> for ObservableGauge<u64>
§type Error = MetricsError
type Error = MetricsError
The type returned in the event of a conversion error.
§fn try_from(
builder: AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64>,
) -> Result<ObservableGauge<u64>, <ObservableGauge<u64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64>>>::Error>
fn try_from( builder: AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64>, ) -> Result<ObservableGauge<u64>, <ObservableGauge<u64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableGauge<u64>, u64>>>::Error>
Performs the conversion.
§impl TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64>> for ObservableUpDownCounter<f64>
impl TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64>> for ObservableUpDownCounter<f64>
§type Error = MetricsError
type Error = MetricsError
The type returned in the event of a conversion error.
§fn try_from(
builder: AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64>,
) -> Result<ObservableUpDownCounter<f64>, <ObservableUpDownCounter<f64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64>>>::Error>
fn try_from( builder: AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64>, ) -> Result<ObservableUpDownCounter<f64>, <ObservableUpDownCounter<f64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<f64>, f64>>>::Error>
Performs the conversion.
§impl TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64>> for ObservableUpDownCounter<i64>
impl TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64>> for ObservableUpDownCounter<i64>
§type Error = MetricsError
type Error = MetricsError
The type returned in the event of a conversion error.
§fn try_from(
builder: AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64>,
) -> Result<ObservableUpDownCounter<i64>, <ObservableUpDownCounter<i64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64>>>::Error>
fn try_from( builder: AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64>, ) -> Result<ObservableUpDownCounter<i64>, <ObservableUpDownCounter<i64> as TryFrom<AsyncInstrumentBuilder<'_, ObservableUpDownCounter<i64>, i64>>>::Error>
Performs the conversion.
Auto Trait Implementations§
impl<'a, I, M> Freeze for AsyncInstrumentBuilder<'a, I, M>
impl<'a, I, M> !RefUnwindSafe for AsyncInstrumentBuilder<'a, I, M>
impl<'a, I, M> !Send for AsyncInstrumentBuilder<'a, I, M>
impl<'a, I, M> !Sync for AsyncInstrumentBuilder<'a, I, M>
impl<'a, I, M> Unpin for AsyncInstrumentBuilder<'a, I, M>where
I: Unpin,
impl<'a, I, M> !UnwindSafe for AsyncInstrumentBuilder<'a, I, M>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<S, P, B, E>(self, other: P) -> And<T, P>
fn and<S, P, B, E>(self, other: P) -> And<T, P>
Create a new
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.