Struct mobc::Pool

pub struct Pool<M>(_)
 where
    M: ConnectionManager;

A generic connection pool.

Methods

impl<M> Pool<M> where
    M: ConnectionManager, 

pub async fn new<E>(manager: M) -> Result<Pool<M>, Error<E>> where
    Error<E>: From<<M as ConnectionManager>::Error>, 

Creates a new connection pool with a default configuration.

pub fn builder() -> Builder<M>

Returns a builder type to configure a new pool.

pub async fn get<'_, E>(&'_ self) -> Result<PooledConnection<M>, Error<E>> where
    Error<E>: From<<M as ConnectionManager>::Error>, 

Retrieves a connection from the pool.

Waits for at most the configured connection timeout before returning an error.

pub async fn get_timeout<'_, E>(
    &'_ self,
    timeout: Duration
) -> Result<PooledConnection<M>, Error<E>> where
    Error<E>: From<<M as ConnectionManager>::Error>, 

Retrieves a connection from the pool, waiting for at most timeout

The given timeout will be used instead of the configured connection timeout.

pub async fn try_get<'_>(&'_ self) -> Option<PooledConnection<M>>

Attempts to retrieve a connection from the pool if there is one available.

Returns None if there are no idle connections available in the pool. This method will not block waiting to establish a new connection.

pub async fn state<'_>(&'_ self) -> State

Returns information about the current state of the pool.

Trait Implementations

impl<M> Clone for Pool<M> where
    M: ConnectionManager, 

Returns a new Pool referencing the same state as self.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.