Struct deadpool::managed::Pool

pub struct Pool<M: Manager, W: From<Object<M>> = Object<M>> { /* private fields */ }

A generic object and connection pool.

This struct can be cloned and transferred across thread boundaries and uses reference counting for its internal state.

Implementations

impl<M: Manager, W: From<Object<M>>> Pool<M, W>

pub fn new(manager: M, max_size: usize) -> Pool<M, W>

Create new connection pool with a given manager and max_size. The manager is used to create and recycle objects and max_size is the maximum number of objects ever created.

pub fn from_config(manager: M, config: PoolConfig) -> Pool<M, W>

Create new connection pool with a given manager and config. The manager is used to create and recycle objects. The config specifies the maximum numbers of objects to be created and timeouts.

pub async fn get(&self) -> Result<W, PoolError<M::Error>>

Retrieve object from pool or wait for one to become available.

pub async fn try_get(&self) -> Result<W, PoolError<M::Error>>

Retrieve object from the pool and do not wait if there is currently no object available and the maximum pool size has been reached.

pub async fn timeout_get(
    &self,
    timeouts: &Timeouts
) -> Result<W, PoolError<M::Error>>

Retrieve object using a different timeout config than the one configured.

pub fn close(&self)

Close the pool

All current and future tasks waiting for objects return Err(PoolError::Closed) immediately.

pub fn is_closed(&self) -> bool

Returns true if the pool has been closed

pub fn status(&self) -> Status

Retrieve status of the pool

pub fn manager(&self) -> &M

Get manager of the pool

Trait Implementations

impl<M: Manager, W: From<Object<M>>> Clone for Pool<M, W>

fn clone(&self) -> Pool<M, W>

Returns a copy of the value.

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

Performs copy-assignment from source.