Struct InstrumentedPool 

pub struct InstrumentedPool<P> { /* private fields */ }

Instrumented pool.

Automatically gathers pool-related metrics and provides relevant traces.

Implementations

impl<P, E> InstrumentedPool<P>

where P: for<'p> InstrumentablePool<'p, Error = E> + Sync, E: Error + Send + 'static,

pub fn instrument<L: Into<Cow<'static, str>>>( label: Option<L>, pool: P, ) -> Result<Self, Error<E>>

Instrument provided resource pool.

Errors

Returns Err if there was a problem collecting pool state.

pub fn update_metrics(&self) -> Result<(), Error<E>>

Manually update pool metrics.

Normally you wouldn’t need to call this directly, as metrics collection occurs automatically as you use the pool.

Errors

Returns Err if there was a problem collecting pool state.

pub async fn get( &self, ) -> Result<InstrumentedResource<<P as InstrumentablePool<'_>>::Resource>, Error<E>>

Acquire instrumented resource from resource pool.

Errors

Returns Err if there was a problem acquiring a resource from the pool.

pub fn try_get( &self, ) -> Result<InstrumentedResource<<P as InstrumentablePool<'_>>::Resource>, Error<E>>

Instantly acquire an instrumented resource from the pool.

Errors

Returns Err if blocking is required, or if this operation is not implemented for this pool type.

pub async fn get_timeout( &self, timeout: Duration, ) -> Result<InstrumentedResource<<P as InstrumentablePool<'_>>::Resource>, Error<E>>

Try to acquire an instrumented resource from the pool, waiting for a bounded time.

Errors

Must return Error::AcquireTimeout if waiting time was exhaused.

Returns Error::NotImplemented if this operation is not implemented for this pool type.

Trait Implementations

impl<P> AsMut<P> for InstrumentedPool<P>

fn as_mut(&mut self) -> &mut P

Converts this type into a mutable reference of the (usually inferred) input type.

impl<P> AsRef<P> for InstrumentedPool<P>

fn as_ref(&self) -> &P

Converts this type into a shared reference of the (usually inferred) input type.

impl<P: Clone> Clone for InstrumentedPool<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug> Debug for InstrumentedPool<P>

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

Formats the value using the given formatter.

impl<P> Deref for InstrumentedPool<P>

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P> DerefMut for InstrumentedPool<P>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<P: Display> Display for InstrumentedPool<P>

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

Formats the value using the given formatter.