Struct heapless::pool::Pool

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

A lock-free memory pool

Implementations

impl<T> Pool<T>

pub const fn new() -> Self

Creates a new empty pool

pub fn alloc(&self) -> Option<Box<T, Uninit>>

Claims a memory block from the pool

Returns None when the pool is observed as exhausted

NOTE: This method does not have bounded execution time because it contains a CAS loop

pub fn free<S>(&self, value: Box<T, S>) where
    S: 'static, 

Returns a memory block to the pool

NOTE: T’s destructor (if any) will run on value iff S = Init

NOTE: This method does not have bounded execution time because it contains a CAS loop

pub fn grow(&self, memory: &'static mut [u8]) -> usize

Increases the capacity of the pool

This method might not fully utilize the given memory block due to alignment requirements.

This method returns the number of new blocks that can be allocated.

pub fn grow_exact<A>(&self, memory: &'static mut MaybeUninit<A>) -> usize where
    A: AsMut<[Node<T>]>, 

Increases the capacity of the pool

Unlike Pool.grow this method fully utilizes the given memory block

Trait Implementations

impl<T> Send for Pool<T>