Struct deadpool_r2d2::Pool

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

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, W> Pool<M, W> where
    M: Manager,
    W: From<Object<M>>, 

pub fn builder(manager: M) -> PoolBuilder<M, W>

Instantiates a builder for a new Pool.

This is the only way to create a Pool instance.

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

Retrieves an Object from this Pool or waits for one to become available.

Errors

See PoolError for details.

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

Retrieves an Object from this Pool and doesn’t wait if there is currently no Object available and the maximum Pool size has been reached.

Errors

See PoolError for details.

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

Retrieves an Object from this Pool using a different timeout than the configured one.

Errors

See PoolError for details.

pub fn resize(&self, max_size: usize)

Resize the pool. This change the max_size of the pool dropping excess objects and/or making space for new ones.

If the pool is closed this method does nothing. The Pool::status method always reports a max_size of 0 for closed pools.

pub fn close(&self)

Closes this Pool.

All current and future tasks waiting for Objects will return PoolError::Closed immediately.

This operation resizes the pool to 0.

pub fn is_closed(&self) -> bool

Indicates whether this Pool has been closed.

pub fn status(&self) -> Status

Retrieves Status of this Pool.

pub fn manager(&self) -> &M

Returns Manager of this Pool.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, W> Debug for Pool<M, W> where
    M: Debug + Manager,
    W: From<Object<M>>,
    <M as Manager>::Type: Debug, 

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

Formats the value using the given formatter.