Struct lease::LockedPool

pub struct LockedPool<T: Send + Sync + 'static> { /* private fields */ }

A pool of objects of type T that can be leased out.

This is a wrapper of pool that once created doesn’t allow any changes to the number of Leases that the Pool contains

Implementations

impl<T: Send + Sync + 'static> LockedPool<T>

pub fn try_into_pool( self ) -> Result<Pool<T>, (LockedPool<T>, PoolConversionError)>

Turns this Pool into a LockedPool

Errors

Will return an error if there are other copies of this LockedPool

pub fn try_get(&self) -> Option<Lease<T>>

Tries to get a Lease if one is available. This function does not block.

For an asynchronous version that returns when one is available use get()

pub async fn get(&self) -> Lease<T>

Returns a future that resolves to a Lease when one is available

Reqires the async feature to be enabled because it requires extra memory

pub fn stream(&self) -> impl Stream<Item = Lease<T>>

Returns a Stream of Leasees

pub fn len(&self) -> usize

Returns the size of the pool

pub fn is_empty(&self) -> bool

Returns true if there are no items being stored.

pub fn available(&self) -> usize

Returns the number of currently available Leasees. Even if the return is non-zero, calling get() immediately afterward can still fail if multiple threads have access to this pool.

Trait Implementations

impl<T: Clone + Send + Sync + 'static> Clone for LockedPool<T>

fn clone(&self) -> LockedPool<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Send + Sync + 'static> Debug for LockedPool<T>

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

Formats the value using the given formatter.

impl<T: Default + Send + Sync + 'static> Default for LockedPool<T>

fn default() -> LockedPool<T>

Returns the “default value” for a type.