Struct wasmtime_runtime::GcRootsList

pub struct GcRootsList(/* private fields */);

A list of GC roots.

This is effectively a builder for a GcRootsIter that will be given to a GC heap when it is time to perform garbage collection.

Implementations

impl GcRootsList

pub unsafe fn add_wasm_stack_root(&mut self, ptr_to_root: SendSyncPtr<u64>)

Add a GC root that is inside a Wasm stack frame to this list.

pub unsafe fn add_root(&mut self, ptr_to_root: SendSyncPtr<VMGcRef>)

Add a GC root to this list.

pub unsafe fn iter<'a>(&'a mut self) -> GcRootsIter<'a>

Get an iterator over all roots in this list.

Safety

Callers must ensure that all the pointers to GC roots that have been added to this list are valid for the duration of the 'a lifetime.

pub fn is_empty(&self) -> bool

Is this list empty?

pub fn clear(&mut self)

Clear this GC roots list.

Trait Implementations

impl Default for GcRootsList

fn default() -> GcRootsList

Returns the “default value” for a type.