Struct MemoryPool

pub struct MemoryPool<T, const SIZE: usize> { /* private fields */ }

Interrupt- and thread-safe memory pool.

See module-level documentation for more information.

Implementations

impl<T, const SIZE: usize> MemoryPool<T, SIZE>

pub const fn new() -> Self

Creates a new MemoryPool.

SIZE is required to be larger than 0.

pub fn reserve(&self) -> Option<MemoryPoolToken<'_, T>>

Reserves an element in the MemoryPool.

Returns None if no element is available.

The returned token has to be initialized via MemoryPoolToken::init before use. See MemoryPool::chunk for a convenience wrapper combining reserving and initializing a Chunk.

pub fn chunk(&self, init_value: T) -> Result<Chunk<'_, T>, T>

Retrieves a Chunk from the MemoryPool and initializes it with init_value.

Returns Err(init_value) if no more Chunks are available.

Convenience wrapper combining MemoryPool::reserve and `MemoryPoolToken::init.

pub fn chunks_available(&self) -> usize

Calculates the amount of chunks currently available.

Due to accesses from interrupts and/or other threads, this value might not be correct. Only intended for metrics.

Trait Implementations

impl<T: Debug, const SIZE: usize> Debug for MemoryPool<T, SIZE>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, const SIZE: usize> Default for MemoryPool<T, SIZE>

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize> Sync for MemoryPool<T, N>