Struct deadpool::unmanaged::Pool

pub struct Pool<T> { /* private fields */ }

A generic object and connection pool. This is the static version of the pool which does not include

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

A pool of existing objects can be created from an existing collection of objects if it has a known exact size:

use deadpool::unmanaged::Pool;
let pool = Pool::from(vec![1, 2, 3]);

Implementations

impl<T> Pool<T>

pub fn new(max_size: usize) -> Self

Create a new empty pool with the given max_size.

pub fn from_config(config: &PoolConfig) -> Self

Create a new empty pool using the given configuration

pub async fn get(&self) -> Result<Object<T>, PoolError>

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

pub fn try_get(&self) -> Result<Object<T>, PoolError>

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,
    timeout: Option<Duration>
) -> Result<Object<T>, PoolError>

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

pub async fn add(&self, obj: T) -> Result<(), (T, PoolError)>

Add object to pool. If the size has already reached max_size this function blocks until the object can be added to the pool. If the pool has been closed a tuple containing the object and the error is returned instead.

pub fn try_add(&self, obj: T) -> Result<(), (T, PoolError)>

Try to add a pool to the object. If the size has already reached max_size or the pool has been closed a tuple containing the object and the cause of the error is returned instead.

pub async fn remove(&self) -> Result<T, PoolError>

Remove an object from the pool. This is a shortcut for

Object::take(pool.get()?.await)

pub fn try_remove(&self) -> Result<T, PoolError>

Try to remove an object from the pool. This is a shortcut for

if let Some(obj) = self.try_get() {
    Some(Object::take(obj))
} else {
    None
}

pub async fn tiemout_remove(
    &self,
    timeout: Option<Duration>
) -> Result<T, PoolError>

Remove object using a different timeout config than the one configured. This is a shortcut for

Object::take(pool.timeout_get()?.await)

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

Trait Implementations

impl<T> Clone for Pool<T>

fn clone(&self) -> Pool<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for Pool<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T, I> From<I> for Pool<T> where
    I: IntoIterator<Item = T>,
    <I as IntoIterator>::IntoIter: ExactSizeIterator, 

fn from(iter: I) -> Pool<T>

Create new pool from the given exact size iterator of objects.