Struct Heap 

pub struct Heap { /* private fields */ }

A first-class heap (plan §5.14): Drop runs mi_heap_delete semantics (blocks migrate to the thread’s backing heap and stay valid) unless built with Heap::new_destroyable, where Drop releases every block at once. The destroyable form inherits C’s contract: callers must not touch its blocks after drop (a lifetime-carrying Allocator impl that makes this unrepresentable is the planned follow-up once allocator_api stabilizes).

Implementations

impl Heap

pub fn new() -> Heap

New heap; dropped ⇒ blocks migrate to the backing heap.

Panics

When the OS refuses the heap’s backing mapping (memory exhaustion) — a defined panic, matching std’s convention for infallible constructors, rather than a null pointer carried into later use.

pub fn new_destroyable() -> Heap

New heap; dropped ⇒ every allocation is released wholesale (arena-style teardown).

Panics

As Heap::new, on memory exhaustion.

pub fn alloc(&self, layout: Layout) -> Option<NonNull<u8>>

Allocate layout, borrowing the heap (so the block cannot outlive it).

pub fn alloc_zeroed(&self, layout: Layout) -> Option<NonNull<u8>>

Zeroed variant of alloc.

pub unsafe fn dealloc(&self, p: NonNull<u8>)

Free a block previously allocated from this heap.

Safety

p came from this heap’s alloc methods and is freed exactly once.

pub fn collect(&self)

Drain cross-thread frees and retire empty pages.

Trait Implementations

impl Default for Heap

fn default() -> Self

Returns the “default value” for a type.

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.