Struct PooledConnection

pub struct PooledConnection<M: Connector> { /* private fields */ }

Wrapper around the actual pooled connection which implements Deref, DerefMut and Drop traits.

Use this connection just as if it was of Connection T and upon leaving a scope the Drop::drop() will take care of returning it to the pool.

Implementations

impl<M: Connector> PooledConnection<M>

pub fn take(this: Self) -> M::Connection

Takes this PooledConnection from its Client permanently. This reduces the size of the Client.

pub fn purge(&mut self) -> Result<(), PurgeError>

Purge the multiplexed connection from the pool. No more forked_connections can be created from the underlying Multiplexed connection

pub fn metrics(this: &Self) -> &Metrics

Get connection statistics

pub fn pool(this: &Self) -> Option<Client<M>>

Returns the Client this PooledConnection belongs to.

Since PooledConnections only hold a Weak reference to the Client they come from, this can fail and return None instead.

Trait Implementations

impl<M: Connector> AsMut<<M as Connector>::Connection> for PooledConnection<M>

fn as_mut(&mut self) -> &mut M::Connection

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

impl<M: Connector> AsRef<<M as Connector>::Connection> for PooledConnection<M>

fn as_ref(&self) -> &M::Connection

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

impl<M> Debug for PooledConnection<M>

where M: Debug + Connector, M::Connection: Debug,

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

Formats the value using the given formatter.

impl<M: Connector> Deref for PooledConnection<M>

type Target = <M as Connector>::Connection

The resulting type after dereferencing.

fn deref(&self) -> &M::Connection

Dereferences the value.

impl<M: Connector> DerefMut for PooledConnection<M>

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

Mutably dereferences the value.

impl<M: Connector> Drop for PooledConnection<M>

fn drop(&mut self)

Executes the destructor for this type.