Struct Pool

pub struct Pool<T> { /* private fields */ }

Lock-free object pool.

Implementations

impl<T> Pool<T>

pub fn bounded( capacity: usize, new: impl Fn() -> T + Send + Sync + 'static, reset: impl Fn(&mut T) + Send + Sync + 'static, ) -> Self

Create a new pool with the given capacity.

Example

use objectpool::Pool;

let pool = Pool::<u32>::bounded(10, Default::default, |_v| {});

pub fn unbounded( new: impl Fn() -> T + Send + Sync + 'static, reset: impl Fn(&mut T) + Send + Sync + 'static, ) -> Self

Create a new pool with the unbounded capacity.

Example

use objectpool::Pool;

let pool = Pool::<u32>::unbounded(Default::default, |_v| {});

pub fn get(&self) -> ReusableObjectRef<'_, T>

Get an object from the pool.

Example

use objectpool::Pool;

let pool = Pool::<u32>::bounded(10, Default::default, |_v| {});

let mut obj = pool.get();

assert_eq!(*obj, 0);

*obj = 42;
drop(obj);

pub fn get_owned(&self) -> ReusableObject<T>

Get an object from the pool.

Example

use objectpool::Pool;

let pool = Pool::<u32>::bounded(10, Default::default, |_v| {});

let mut obj = pool.get_owned();

assert_eq!(*obj, 0);

*obj = 42;
drop(obj);

pub fn get_or_else(&self, fallback: impl Fn() -> T) -> ReusableObjectRef<'_, T>

Get an object from the pool with a fallback.

Example

use objectpool::Pool;

let pool = Pool::<u32>::bounded(10, Default::default, |_| {});

let mut obj = pool.get_or_else(|| 42);

assert_eq!(*obj, 42);

pub fn get_owned_or_else(&self, fallback: impl Fn() -> T) -> ReusableObject<T>

Get an object from the pool with a fallback.

Example

use objectpool::Pool;

let pool = Pool::<u32>::bounded(10, Default::default, |_| {});

let mut obj = pool.get_owned_or_else(|| 42);

assert_eq!(*obj, 42);

pub fn clear(&self)

Clear the pool.

Example

use objectpool::Pool;

let pool = Pool::<u32>::bounded(10, Default::default, |v| {});

let mut obj = pool.get();
*obj = 42;
drop(obj);

pool.clear();

Trait Implementations

impl<T> Clone for Pool<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> Drop for Pool<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for Pool<T>

impl<T: Sync> Sync for Pool<T>