Struct refpool::Pool

pub struct Pool<A, S = PoolUnsync> where
    S: PoolSyncType<A>,  { /* fields omitted */ }

A pool of preallocated memory sized to match type A.

In order to use it to allocate objects, pass it to PoolRef::new() or PoolRef::default().

Example

let mut pool: Pool<usize> = Pool::new(1024);
let pool_ref = PoolRef::new(&mut pool, 31337);
assert_eq!(31337, *pool_ref);

Methods

impl<A, S> Pool<A, S> where
    S: PoolSyncType<A>, 

pub fn new(max_size: usize) -> Self

Construct a new pool with a given max size.

pub fn get_max_size(&self) -> usize

Get the maximum size of the pool.

pub fn get_pool_size(&self) -> usize

Get the current size of the pool.

pub fn is_full(&self) -> bool

Test if the pool is currently full.

pub fn fill(&self)

Fill the pool with empty allocations.

This operation will pre-allocate self.get_max_size() - self.get_pool_size() memory chunks, without initialisation, and put them in the pool.

Trait Implementations

impl<A, S> Clone for Pool<A, S> where
    S: PoolSyncType<A>, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A, S> Drop for Pool<A, S> where
    S: PoolSyncType<A>, 

fn drop(&mut self)

Executes the destructor for this type.