Struct lease::init::InitPool

pub struct InitPool<T: Send + Sync + 'static, I: Init> { /* private fields */ }

A pool of objects of type T that can be leased out. Just like a Pool, but it also carries an initializer that ensures each item is consistently initialized

Implementations

impl<T: Send + Sync + 'static, I: Init> InitPool<T, I>

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

Turns this Pool into a LockedPool

Errors

Will return an error if any of the variants in PoolConversionError apply

pub fn new(init: I) -> Self

Creates a new empty Pool

pub fn new_from<O: Into<I>>(init: O) -> Self

Creates a new empty Pool that will be initialized using init

pub fn init(&self) -> I::Output

Returns the output of the initializer so that consumers can get an initialized value that isn’t tied to the pool

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 try_get_or_new(&self) -> Lease<T>

where I::Output: Into<T>,

For the asynchronous version of this function see get_or_new()

Tries to get an existing Lease if available and if not returns a new one that has been added to the pool.

Calling this method repeatedly can cause the pool size to increase without bound.

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

where I::Output: Future<Output = T>,

Asynchronous version of try_get_or_new()

Tries to get an existing Lease if available and if not returns a new one that has been added to the pool.

Calling this method repeatedly can cause the pool size to increase without bound.

pub fn try_get_or_try_new<E>(&self) -> Result<Lease<T>, E>

where I::Output: Into<Result<T, E>>,

For the asynchronous version of this function see get_or_try_new()

Tries to get an existing Lease if available and if not tries to create a new one that has been added to the pool.

Calling this method repeatedly can cause the pool size to increase without bound.

Errors

Returns an error if the stored initializer errors

pub async fn get_or_try_new<E>(&self) -> Result<Lease<T>, E>

where I::Output: Future<Output = Result<T, E>>,

Asynchronous version of try_get_or_try_new()

Tries to get an existing Lease if available and if not tries to create a new one that has been added to the pool.

Calling this method repeatedly can cause the pool size to increase without bound.

Errors

Returns an error if the stored initializer errors

pub fn try_get_or_new_with_cap(&self, cap: usize) -> Option<Lease<T>>

where I::Output: Into<T>,

For the asynchronous version of this function see get_or_new_with_cap()

Just like get_or_new() but caps the size of the pool. Once len() == cap then None is returned.

pub async fn get_or_new_with_cap(&self, cap: usize) -> Lease<T>

where I::Output: Future<Output = T>,

Asynchronous version of get_or_new_with_cap()

Just like get_or_new() but caps the size of the pool. Once len() == cap then it waits for an open lease.

pub fn try_get_or_try_new_with_cap<E>( &self, cap: usize ) -> Result<Option<Lease<T>>, E>

where I::Output: Into<Result<T, E>>,

For the asynchronous version of this function see get_or_try_new_with_cap()

Just like get_or_try_new() but caps the size of the pool. Once len() == cap then None is returned.

Errors

Returns an error if the stored initializer errors

pub async fn get_or_try_new_with_cap<E>( &self, cap: usize ) -> Result<Lease<T>, E>

where I::Output: Future<Output = Result<T, E>>,

Asynchronous version of get_or_try_new_with_cap()

Just like get_or_try_new() but caps the size of the pool. Once len() == cap then it waits for an open lease.

Errors

Returns an error if the stored initializer errors

pub fn len(&self) -> usize

Returns the size of the pool

pub fn clear(&self)

Sets the size of the pool to zero

This will disassociate all current Leasees and when they go out of scope the objects they’re holding will be dropped

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.

pub fn is_empty(&self) -> bool

Returns true if there are no items being stored.

pub fn disassociate(&self, lease: &Lease<T>)

Disassociates the Lease from this InitPool

Trait Implementations

impl<T: Send + Sync + 'static, I: Init> Clone for InitPool<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.