Struct MipsMcuHeap

pub struct MipsMcuHeap { /* private fields */ }

Implementations

impl MipsMcuHeap

pub const fn empty() -> MipsMcuHeap

Create a new UNINITIALIZED heap allocator.

You must initialize this heap using the init method before using the allocator.

pub fn init(&self)

Initialize heap with heap start location from linker and a defined initial size.

pub fn used(&self) -> usize

Returns an estimate of the amount of bytes in use.

pub fn free(&self) -> usize

Returns the amount of bytes currently available.

This method does not consider possible heap extensions

pub fn bottom(&self) -> *mut u8

Returns the start (bottom) of the heap.

pub fn top(&self) -> *mut u8

Returns the end (top) of the heap.

pub fn headroom(&self) -> usize

Returns the current distance to the bottom of the stack.

This is an estimate amount of memory that could be added to the heap by automatic extension. An estimate of the total available free heap memory is the sum of free() and headroom().

pub unsafe fn reserve(&self, free_bytes: usize) -> Result<(), Error>

Try to extend the stack so that it has at least an amount of free_bytes available.

Fails if there is not enough headroom. Does nothing if there are already enough free bytes.

Safety

This method is considered unsafe because it increases the likelihood of heap/stack collisions.

Trait Implementations

impl GlobalAlloc for MipsMcuHeap

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout.

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout.

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned.

unsafe fn realloc( &self, ptr: *mut u8, layout: Layout, new_size: usize, ) -> *mut u8

Shrinks or grows a block of memory to the given new_size in bytes. The block is described by the given ptr pointer and layout.