Struct ChunkPool

pub struct ChunkPool {
    inner: Mutex<ChunkPoolInner>,
}

A simple pool for allocating and recycling memory chunks of a fixed size, protected by a mutex.

Chunks in the pool are stored as a linked list using a pointer to the next element at the beginning of the chunk.

Fields

inner: Mutex<ChunkPoolInner>

Implementations

impl ChunkPool

pub fn new() -> Self

pub fn allocate_chunk(&self, size: usize) -> Result<NonNull<Chunk>, AllocError>

Pop a chunk from the pool or allocate a new one.

If the requested size is not equal to the default chunk size, a new chunk is allocated.

unsafe fn recycle_chunks(&self, chunk: NonNull<Chunk>)

Put the provided list of chunks into the pool.

Chunks with size different from the default chunk size are deallocated immediately.

Safety

Ownership of the provided chunks is transfered to the pool, nothing else can access them after this function runs.

pub fn purge_chunks(&self, target: u32, count: u32) -> bool

Deallocate chunks until the pool contains at most target items, or count chunks have been deallocated.

Returns true if the target number of chunks in the pool was reached, false if this method stopped before reaching the target.

Purging chunks can be expensive so it is preferable to perform this operation outside of the critical path. Specifying a lower count allows the caller to split the work and spread it over time.

pub fn purge_all_chunks(&self)

Deallocate all of the chunks.

Trait Implementations

impl Drop for ChunkPool

fn drop(&mut self)

Executes the destructor for this type.