Struct ObjectPool 

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

A thread-safe object pool for reusing allocations.

Use get() to grab an object (created fresh if the pool is empty). When you drop the returned Pooled wrapper, the object goes back to the pool for reuse.

Examples

use grafeo_common::memory::ObjectPool;

// Pool of vectors that get cleared on return
let pool = ObjectPool::with_reset(Vec::<u8>::new, |v| v.clear());

let mut buf = pool.get();
buf.extend_from_slice(&[1, 2, 3]);
// buf is returned to pool when dropped, and cleared

Implementations

impl<T> ObjectPool<T>

pub fn new<F>(factory: F) -> Self

where F: Fn() -> T + Send + Sync + 'static,

Creates a new object pool with the given factory function.

pub fn with_reset<F, R>(factory: F, reset: R) -> Self

where F: Fn() -> T + Send + Sync + 'static, R: Fn(&mut T) + Send + Sync + 'static,

Creates a new object pool with a factory and reset function.

The reset function is called when an object is returned to the pool, allowing you to clear or reinitialize the object for reuse.

pub fn with_max_size(self, max_size: usize) -> Self

Sets the maximum pool size.

Objects returned when the pool is at capacity will be dropped instead.

pub fn prefill(&self, count: usize)

Pre-populates the pool with count objects.

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

Takes an object from the pool, creating a new one if necessary.

Returns a Pooled wrapper that will return the object to the pool when dropped.

pub fn take(&self) -> T

Takes an object from the pool without wrapping it.

The caller is responsible for returning the object via put() if desired.

pub fn put(&self, value: T)

Returns an object to the pool.

If the pool is at capacity, the object is dropped instead.

pub fn available(&self) -> usize

Returns the current number of objects in the pool.

pub fn max_size(&self) -> usize

Returns the maximum pool size.

pub fn clear(&self)

Clears all objects from the pool.

impl<T: 'static> ObjectPool<Vec<T>>

pub fn new_vec_pool() -> Self

Creates a new vector pool.

pub fn new_vec_pool_with_capacity(capacity: usize) -> Self

Creates a new vector pool with pre-allocated capacity.