Struct Pool

pub struct Pool<M>
where
    M: ManageConnection,
{ /* private fields */ }

A generic connection pool.

Implementations

impl<M: ManageConnection> Pool<M>

pub fn builder() -> Builder<M>

Returns a Builder instance to configure a new pool.

pub async fn get(&self) -> Result<PooledConnection<'_, M>, RunError<M::Error>>

Retrieves a connection from the pool.

pub async fn get_owned( &self, ) -> Result<PooledConnection<'static, M>, RunError<M::Error>>

Retrieves an owned connection from the pool

Using an owning PooledConnection makes it easier to leak the connection pool. Therefore, Pool::get (which stores a lifetime-bound reference to the pool) should be preferred whenever possible.

pub async fn dedicated_connection(&self) -> Result<M::Connection, M::Error>

Get a new dedicated connection that will not be managed by the pool. An application may want a persistent connection (e.g. to do a postgres LISTEN) that will not be closed or repurposed by the pool.

This method allows reusing the manager’s configuration but otherwise bypassing the pool

pub fn state(&self) -> State

Returns information about the current state of the pool.

pub fn add(&self, conn: M::Connection) -> Result<(), AddError<M::Connection>>

Adds a connection to the pool.

If the connection is broken, or the pool is at capacity, the connection is not added and instead returned to the caller in Err.

Trait Implementations

impl<M> Clone for Pool<M>

where M: ManageConnection,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Pool<M>

where M: ManageConnection,

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

Formats the value using the given formatter.