Struct mobc::Pool

pub struct Pool<M: Manager>(_);

A generic connection pool.

Methods

impl<M: Manager> Pool<M>

pub fn new(manager: M) -> Pool<M>

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 set_max_open_conns<'_>(&'_ self, n: u64)

Sets the maximum number of connections managed by the pool.

0 means unlimited, defaults to 10.

pub async fn set_max_idle_conns<'_>(&'_ self, n: u64)

Sets the maximum idle connection count maintained by the pool.

The pool will maintain at most this many idle connections at all times, while respecting the value of max_open.

Defaults to 2.

pub async fn set_conn_max_lifetime<'_>(&'_ self, max_lifetime: Option<Duration>)

Sets the maximum lifetime of connections in the pool.

Expired connections may be closed lazily before reuse.

None meas reuse forever. Defaults to None.

Panics

Panics if max_lifetime is the zero Duration.

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

Returns a single connection by either opening a new connection or returning an existing connection from the connection pool. Conn will block until either a connection is returned or timeout.

pub async fn get_timeout<'_>(
    &'_ self,
    duration: Duration
) -> Result<Connection<M>, Error<M::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 state<'_>(&'_ self) -> State

Returns information about the current state of the pool.

Trait Implementations

impl<M: Manager> Clone for Pool<M>

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.

impl<M: Manager> Drop for Pool<M>

fn drop(&mut self)

Executes the destructor for this type.