Struct dynamic_pool::DynamicPool

pub struct DynamicPool<T: DynamicReset> { /* fields omitted */ }

a lock-free, thread-safe, dynamically-sized object pool.

this pool begins with an initial capacity and will continue creating new objects on request when none are available. pooled objects are returned to the pool on destruction (with an extra provision to optionally "reset" the state of an object for re-use).

if, during an attempted return, a pool already has maximum_capacity objects in the pool, the pool will throw away that object.

Methods

impl<T: DynamicReset> DynamicPool<T>

pub fn new<F: Fn() -> T + Sync + Send + 'static>(
    initial_capacity: usize,
    maximum_capacity: usize,
    create: F
) -> DynamicPool<T>

creates a new DynamicPool<T>. this pool will create initial_capacity objects, and retain up to maximum_capacity objects.

panics.

panics if initial_capacity > maximum_capacity.

pub fn take(&self) -> DynamicPoolItem<T>

takes an item from the pool, creating one if none are available.

pub fn try_take(&self) -> Option<DynamicPoolItem<T>>

attempts to take an item from the pool, returning none if none is available. will never allocate.

pub fn available(&self) -> usize

returns the number of free objects in the pool.

pub fn used(&self) -> usize

returns the number of objects currently in use. does not include objects that have been detached.

pub fn capacity(&self) -> usize

Trait Implementations

impl<T: DynamicReset> Clone for DynamicPool<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 + DynamicReset> Debug for DynamicPool<T>

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

Formats the value using the given formatter.