Trait mnemos_alloc::heap::UnderlyingAllocator

pub trait UnderlyingAllocator {
    const INIT: Self;

    // Required methods
    unsafe fn init(&self, start: NonNull<u8>, len: usize);
    unsafe fn alloc(&self, layout: Layout) -> *mut u8;
    unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout);
}

“Underlying Allocator”“ Trait

This trait serves to abstract over a general purpose GlobalAlloc implementation, and allows mnemos-alloc to do “the right thing” when it comes to the async wrapper types when used with any allocator.

UnderlyingAllocator::alloc() and UnderlyingAllocator::dealloc() must be implemented. UnderlyingAllocator::init() may or may not be necessary, depending on your allocator.

Features

When the “use-std” feature of this crate is active, an implementation of UnderlyingAllocator is provided for std::alloc::System.

Required Associated Constants

const INIT: Self

A constant initializer of the allocator.

May or may not require a call to UnderlyingAllocator::init() before the allocator is actually ready for use.

Required Methods

unsafe fn init(&self, start: NonNull<u8>, len: usize)

Initialize the allocator, if it is necessary to populate with a region of memory.

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

Allocate a region of memory

SAFETY: The same as GlobalAlloc::alloc().

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

Deallocate a region of memory

SAFETY: The same as GlobalAlloc::dealloc().

Implementations on Foreign Types

impl UnderlyingAllocator for System

const INIT: Self = std::alloc::System

unsafe fn init(&self, _start: NonNull<u8>, _len: usize)

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

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

Implementors

impl UnderlyingAllocator for SingleThreadedLinkedListAllocator

const INIT: Self = _