Struct deadpool::unmanaged::Pool

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

Generic object and connection pool. This is the static version of the pool which doesn’t 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

Creates a new empty Pool with the given max_size.

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

Create a new empty Pool using the given PoolConfig.

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

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

Errors

See PoolError for details.

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

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

Errors

See PoolError for details.

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

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

Errors

See PoolError for details.

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

Adds an object to this Pool.

If the Pool size has already reached its maximum, then this function blocks until the object can be added to the Pool.

Errors

If the Pool has been closed a tuple containing the object and the PoolError is returned instead.

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

Tries to add an object to this Pool.

Errors

If the Pool size has already reached its maximum, or the Pool has been closed, then a tuple containing the object and the PoolError is returned instead.

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

Removes an Object from this Pool.

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

Tries to remove an Object from this Pool.

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

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

pub fn close(&self)

Closes this Pool.

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

pub fn is_closed(&self) -> bool

Indicates whether this Pool has been closed.

pub fn status(&self) -> Status

Retrieves Status of this Pool.

Trait Implementations

impl<T> Clone for Pool<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Pool<T>

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

Formats the value using the given formatter.

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) -> Self

Creates a new Pool from the given ExactSizeIterator of Objects.