Struct good_memory_allocator::Allocator

pub struct Allocator<const SMALLBINS_AMOUNT: usize = DEFAULT_SMALLBINS_AMOUNT, const ALIGNMENT_SUB_BINS_AMOUNT: usize = DEFAULT_ALIGNMENT_SUB_BINS_AMOUNT>where
    SmallestTypeWhichHasAtLeastNBitsStruct<ALIGNMENT_SUB_BINS_AMOUNT>: SmallestTypeWhichHasAtLeastNBitsTrait,{ /* private fields */ }

A linked list memory allocator.

This allocator allows configuring the amount of smallbins and alignment sub-bins that it uses. For more information about this value, read the crate’s top level documentation.

Implementations

impl<const SMALLBINS_AMOUNT: usize, const ALIGNMENT_SUB_BINS_AMOUNT: usize> Allocator<SMALLBINS_AMOUNT, ALIGNMENT_SUB_BINS_AMOUNT>where
    SmallestTypeWhichHasAtLeastNBitsStruct<ALIGNMENT_SUB_BINS_AMOUNT>: SmallestTypeWhichHasAtLeastNBitsTrait,

pub const fn empty() -> Self

Creates an empty heap allocator without any heap memory region, which will always return null on allocation requests.

To intiialize this allocator, use the init method.

pub fn was_initialized(&self) -> bool

Checks if the heap memory region was already initialized by calling init.

pub unsafe fn init(&mut self, heap_start_addr: usize, heap_size: usize)

Initializes the heap allocator with the given memory region.

Safety

If the allocator was already initialized, this function will panic.

The Allocator on which this was called must not be moved, and its address in memory must not change, otherwise undefined behaviour will occur. This is because the heap region now contains pointers to fields of this struct, and if this struct will move, the address of its fields will change, and those pointers will now be invalid.

The provided memory region must be valid and non-null, and must not be used by anything else.

If after aligning the start and end addresses, the size of the heap is 0, the function panics.

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

Allocates memory.

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

Deallocates memory.

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

Resizes an allocation previously returned from alloc or realloc. The alignment of the content will stay the same.

Trait Implementations

impl<const SMALLBINS_AMOUNT: usize, const ALIGNMENT_SUB_BINS_AMOUNT: usize> Debug for Allocator<SMALLBINS_AMOUNT, ALIGNMENT_SUB_BINS_AMOUNT>where
    SmallestTypeWhichHasAtLeastNBitsStruct<ALIGNMENT_SUB_BINS_AMOUNT>: SmallestTypeWhichHasAtLeastNBitsTrait,

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

Formats the value using the given formatter.

impl<const SMALLBINS_AMOUNT: usize, const ALIGNMENT_SUB_BINS_AMOUNT: usize> Send for Allocator<SMALLBINS_AMOUNT, ALIGNMENT_SUB_BINS_AMOUNT>where
    SmallestTypeWhichHasAtLeastNBitsStruct<ALIGNMENT_SUB_BINS_AMOUNT>: SmallestTypeWhichHasAtLeastNBitsTrait,