Struct SharedBoundedPool 

pub struct SharedBoundedPool<Resource, Reset> { /* private fields */ }

A threadsafe resource pool with a fixed number of Resources.

Implementations

impl<Resource, Reset> SharedBoundedPool<Resource, Reset>

pub fn new<F>(pool_size: usize, init_resource: F, reset_resource: Reset) -> Self

where F: FnMut() -> Resource, Reset: ResetResource<Resource> + Clone,

Create a new SharedBoundedPool which has the indicated, fixed number of Resources.

Each Resource is immediately initialized, using the provided function.

Whenever a Resource is returned to the pool, reset_resource is run on it first.

impl<Resource: Default, Reset> SharedBoundedPool<Resource, Reset>

pub fn new_default(pool_size: usize, reset_resource: Reset) -> Self

where Reset: ResetResource<Resource> + Clone,

Create a new SharedBoundedPool which has the indicated, fixed number of Resources.

Each Resource is immediately initialized to its default value.

Whenever a Resource is returned to the pool, reset_resource is run on it first.

impl<Resource> SharedBoundedPool<Resource, ResetNothing>

pub fn new_without_reset<F>(pool_size: usize, init_resource: F) -> Self

where F: FnMut() -> Resource,

Create a new SharedBoundedPool which has the indicated, fixed number of Resources.

Each Resource is immediately initialized, using the provided function.

When a Resource is returned to the pool, it is not reset in any way.

impl<Resource: Default> SharedBoundedPool<Resource, ResetNothing>

pub fn new_default_without_reset(pool_size: usize) -> Self

Create a new SharedBoundedPool which has the indicated, fixed number of Resources.

Each Resource is immediately initialized to its default value.

When a Resource is returned to the pool, it is not reset in any way.

impl<Resource, Reset: ResetResource<Resource> + Clone> SharedBoundedPool<Resource, Reset>

pub fn try_get( &self, ) -> Result<PooledResource<Self, Resource>, ResourcePoolEmpty>

Get a Resource from the pool, if any are available.

pub fn get(&self) -> PooledResource<Self, Resource>

Get a Resource from the pool.

May need to wait for a resource to become available.

Potential Panics or Deadlocks

If self.pool_size() == 0, then this method will panic or deadlock. This method may also cause a deadlock if no Resources are currently available, and the current thread needs to make progress in order to release a Resource.

pub fn pool_size(&self) -> usize

Get the total number of Resources in this pool, whether available or in-use.

pub fn available_resources(&self) -> usize

Get the number of Resources in the pool which are not currently being used.

Trait Implementations

impl<Resource, ResetResource: Clone> Clone for SharedBoundedPool<Resource, ResetResource>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Resource: Debug, Reset: Debug> Debug for SharedBoundedPool<Resource, Reset>

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

Formats the value using the given formatter.

impl<Resource, ResetResource, S> MirroredClone<S> for SharedBoundedPool<Resource, ResetResource>

where ResetResource: MirroredClone<S>, S: Speed,

Available on crate feature clone-behavior only.

fn mirrored_clone(&self) -> Self

Get a clone that shares all semantically-important mutable state with its source.

fn fast_mirrored_clone(&self) -> Self

where S: FastSpeed,

Get a clone that shares all semantically-important mutable state with its source.