Struct shmalloc::Shmeap

pub struct Shmeap<const SIZE: usize> { /* fields omitted */ }

Use shmalloc!

Example

use shmalloc::Shmeap;

// declare a heap with 2^24 bytes of memory available
#[global_allocator]
static ALLOCATOR: Shmeap<{ 1 << 24 }> = Shmeap::new();

Implementations

impl<const SIZE: usize> Shmeap<SIZE>

pub const fn new() -> Shmeap<SIZE>

Instantiate a new shmeap

pub fn used(&self) -> usize

Check how many bytes are currently in use by the heap

pub fn free(&self) -> usize

Check how many bytes are free in the heap

Trait Implementations

impl<const SIZE: usize> GlobalAlloc for Shmeap<SIZE>

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

Allocate memory as described by the given layout.

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

Deallocate 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

Shrink or grow a block of memory to the given new_size. The block is described by the given ptr pointer and layout.