Struct Heap 

pub struct Heap { /* private fields */ }

A handle to a mimalloc heap.

Allocations from a heap can be freed from any thread. Dropping a Heap moves its live blocks to the main heap (via mi_heap_delete).

Implementations

impl Heap

pub fn new() -> Option<Self>

Create a new heap. Returns None on OOM.

pub fn new_in_arena(arena_id: ArenaId) -> Option<Self>

Create a heap that allocates exclusively from the given arena.

pub fn main() -> Self

Get the main heap.

pub unsafe fn heap_of(ptr: *const u8) -> Option<Self>

Get the heap that owns ptr.

Safety

ptr must be a valid mimalloc-allocated pointer.

pub unsafe fn contains(&self, ptr: *const u8) -> bool

Check if this heap contains ptr.

Safety

ptr must be valid.

pub unsafe fn malloc(&self, size: usize) -> *mut u8

Allocate size bytes from this heap.

Safety

The returned pointer must be freed with mi_free (cross-heap frees are allowed).

pub unsafe fn zalloc(&self, size: usize) -> *mut u8

Allocate zero-initialized memory from this heap.

Safety

The returned pointer must be freed with mi_free.

pub unsafe fn malloc_aligned(&self, size: usize, alignment: usize) -> *mut u8

Allocate aligned memory from this heap.

Safety

The returned pointer must be freed with mi_free.

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

Reallocate memory from this heap.

Safety

ptr must be a valid mimalloc pointer. The returned pointer must be freed with mi_free.

pub fn delete(self)

Delete this heap, moving live blocks to the main heap. Consumes self without running Drop. Borrowed heap handles are left untouched.

pub unsafe fn destroy(self)

Destroy this heap, freeing all live blocks.

Safety

All pointers from this heap become dangling. Borrowed heap handles are left untouched.

pub fn collect(&self, force: bool)

Force garbage collection on this heap.

pub fn stats_json(&self) -> String

Allocation statistics for this heap as JSON. Returns empty string on failure.

pub fn stats_print(&self) -> String

Allocation statistics for this heap in mimalloc’s human-readable text format.

pub fn as_ptr(&self) -> *mut mi_heap_t

Raw pointer to the underlying mi_heap_t.

Trait Implementations

impl Drop for Heap

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Heap

impl Sync for Heap