Struct HeapMemoryManager 

pub struct HeapMemoryManager<P: Payload> { /* private fields */ }

A heap-backed fixed-capacity memory manager.

Implementations

impl<P: Payload> HeapMemoryManager<P>

pub fn new(capacity: usize) -> Self

Create a new manager with given fixed capacity.

The manager pre-allocates capacity slots, all initially None. memory_class defaults to MemoryClass::Host.

pub fn with_memory_class(capacity: usize, mem_class: MemoryClass) -> Self

Create a new manager with given capacity and explicit memory_class.

pub fn configured_capacity(&self) -> usize

Return the configured capacity.

Trait Implementations

impl<P: Payload> HeaderStore for HeapMemoryManager<P>

type HeaderGuard<'a> = HeapHeaderGuard<'a> where Self: 'a

Guard type returned by HeaderStore::peek_header.

fn peek_header( &self, token: MessageToken, ) -> Result<Self::HeaderGuard<'_>, MemoryError>

Borrow the header of the message identified by token.

impl<P: Payload> MemoryManager<P> for HeapMemoryManager<P>

type ReadGuard<'a> = HeapReadGuard<'a, P> where Self: 'a

Shared read guard returned by MemoryManager::read.

type WriteGuard<'a> = HeapWriteGuard<'a, P> where Self: 'a

Exclusive mutable guard returned by MemoryManager::read_mut.

fn store(&mut self, value: Message<P>) -> Result<MessageToken, MemoryError>

Allocate storage for value and return its token.

fn read(&self, token: MessageToken) -> Result<Self::ReadGuard<'_>, MemoryError>

Borrow a stored message immutably.

fn read_mut( &mut self, token: MessageToken, ) -> Result<Self::WriteGuard<'_>, MemoryError>

Borrow a stored message mutably.

fn free(&mut self, token: MessageToken) -> Result<(), MemoryError>

Free the slot identified by token.

fn available(&self) -> usize

Return the number of currently free slots.

fn capacity(&self) -> usize

Return the total slot capacity of the manager.

fn memory_class(&self) -> MemoryClass

Return the memory class represented by this manager.