Struct SharedUnboundedPool 

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

A threadsafe resource pool with a growable number of Resources.

Implementations

impl<Resource, Reset> SharedUnboundedPool<Resource, Reset>

pub fn new(reset_resource: Reset) -> Self

where Reset: ResetResource<Resource> + Clone,

Create a new SharedUnboundedPool, which initially has zero Resources.

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

Potential Panics or Deadlocks

reset_resource must not call any method on the returned pool or any Clone or MirroredClone of it; otherwise, a panic or deadlock may occur.

Ideally, an reset_resource closure should not capture any SharedUnboundedPool.

impl<Resource> SharedUnboundedPool<Resource, ResetNothing>

pub fn new_without_reset() -> Self

Create a new SharedUnboundedPool, which initially has zero Resources.

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

impl<Resource, Reset> SharedUnboundedPool<Resource, Reset>

where Resource: Default, Reset: ResetResource<Resource> + Clone,

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

Get a Resource from the pool, returning a default Resource if none were already available in the pool.

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

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

where F: FnOnce() -> Resource,

Get a Resource from the pool.

Potential Panics or Deadlocks

init_resource must not call any method on self or a Clone or MirroredClone associated with self; otherwise, a panic or deadlock may occur.

Ideally, an init_resource closure should not capture any SharedUnboundedPool.

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 SharedUnboundedPool<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 SharedUnboundedPool<Resource, Reset>

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

Formats the value using the given formatter.

impl<Resource, Reset> Default for SharedUnboundedPool<Resource, Reset>

where Reset: ResetResource<Resource> + Clone + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<Resource, ResetResource, S> MirroredClone<S> for SharedUnboundedPool<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.