Struct incinerator::Heap

pub struct Heap<Hdr: 'static> { /* fields omitted */ }

A garbage-collected heap. See the module-level docs for more information about the garbage collection algorithm.

Implementations

impl<Hdr: 'static> Heap<Hdr>

pub fn start(self: Pin<Arc<Heap<Hdr>>>) -> HeapRegistration<Hdr>

Start using this heap on this thread, pinning the heap until the final HeapRegistration created on this thread is dropped.

Returns None if we are already using this thread. If this is the first time start is called on this thread, blocks until the garbage collector stops its current collection and lets us enter the thread list.

pub fn new() -> Pin<Arc<Heap<Hdr>>>

Create a new managed heap sourcing blocks from the system allocator.

pub fn from_alloc(alloc: Box<dyn GlobalAlloc + Send>) -> Pin<Arc<Heap<Hdr>>>

Create a garbage collected heap which uses alloc as a sub-allocator for large blocks which the garbage collector then splits and manages. alloc may be called from different threads.

Trait Implementations

impl<Hdr: Debug + 'static> Debug for Heap<Hdr>

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

Formats the value using the given formatter.