Struct ObjectPool 

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

A thread-safe queue that allows concurrent access and is used for pooling items.

Implementations

impl<T> ObjectPool<T>

pub fn new<A>(args: A, initial_size: usize, capacity: Option<usize>) -> Self

where T: AsPooled<A>, A: Clone,

Create an object pool consisting of initial_size object initialized using AsPooled::create.

The argument capacity can be provided to place an upper bound on the number of objects in the pool. If initial_size > capacity, the pool will be created with excess items.

pub fn try_new<A>( args: A, initial_size: usize, capacity: Option<usize>, ) -> Result<Self, T::Error>

where T: TryAsPooled<A>, A: Clone,

Create an object pool consisting of initial_size object initialized using TryAsPooled::try_create.

The argument capacity can be provided to place an upper bound on the number of objects in the pool. If initial_size > capacity, the pool will be created with excess items.

pub fn try_get_ref<A>(&self, args: A) -> Result<PooledRef<'_, T>, T::Error>

where T: TryAsPooled<A>,

Try to retrieve an object from the pool. If the pool is non-empty, then invoke TryAsPooled::try_modify on the object with the given arguments. Otherwise, invoke TryAsPooled::try_create to create a new object.

If try_modify fails, the potentially modified object will not be returned to the queue and will instead be dropped.

pub fn get_ref<A>(&self, args: A) -> PooledRef<'_, T>

where T: AsPooled<A>,

Try to retrieve an object from the pool. If the pool is non-empty, then invoke AsPooled::modify on the object with the given arguments. Otherwise, invoke AsPooled::create to create a new object.

Unlike ObjectPool::try_get_ref, this interface should be infallible.

If modify panics, the potentially modified object will not be returned to the queue and will instead be dropped.

pub fn try_get<A>(self: &Arc<Self>, args: A) -> Result<PooledArc<T>, T::Error>

where T: TryAsPooled<A>,

Try to retrieve an object from the pool. If the pool is non-empty, then invoke [TryAsPooled::modify] on the object with the given arguments. Otherwise, invoke [TryAsPooled::create] to create a new object.

If try_modify fails, the potentially modified object will not be returned to the queue and will instead be dropped.

pub fn get<A>(self: &Arc<Self>, args: A) -> PooledArc<T>

where T: AsPooled<A>,

Try to retrieve an object from the pool. If the pool is non-empty, then invoke AsPooled::modify on the object with the given arguments. Otherwise, invoke AsPooled::create to create a new object.

Unlike ObjectPool::try_get, this interface should be infallible.

If modify panics, the potentially modified object will not be returned to the queue and will instead be dropped.

pub fn len(&self) -> usize

Return the number of items currently in the queue.

pub fn is_empty(&self) -> bool

Return whether or not the queue is empty.

Trait Implementations

impl<T: Debug> Debug for ObjectPool<T>

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

Formats the value using the given formatter.