Struct deadpool::unmanaged::Pool

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

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 async fn get<'_>(&'_ self) -> Object<T>

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

pub fn try_get(&self) -> Option<Object<T>>

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 add<'_>(&'_ self, obj: T)

Add object to pool. If the size has already reached max_size this function blocks until the object can be added to the pool.

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

Try to add a pool to the object. If the size has already reached max_size the object is returned as Err<T>.

pub async fn remove<'_>(&'_ self) -> T

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

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

pub fn try_remove(&self) -> Option<T>

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 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, 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.