Struct DynamicRootSet

pub struct DynamicRootSet<'gc>(/* private fields */);

A way of registering GC roots dynamically.

Use this type as (a part of) an Arena root to enable dynamic rooting of GC’d objects through DynamicRoot handles.

Implementations

impl<'gc> DynamicRootSet<'gc>

pub fn new(mc: &Mutation<'gc>) -> Self

Creates a new, empty root set.

pub fn stash<R: for<'a> Rootable<'a>>( &self, mc: &Mutation<'gc>, root: Root<'gc, R>, ) -> DynamicRoot<R>

Puts a root inside this root set.

The returned handle can be freely stored outside the current arena, and will keep the root alive across garbage collections.

pub fn fetch<'a, R: for<'r> Rootable<'r>>( &self, root: &'a DynamicRoot<R>, ) -> &'a Root<'gc, R>

Gets immutable access to the given root.

Panics

Panics if the handle doesn’t belong to this root set. For the non-panicking variant, use try_fetch.

pub fn try_fetch<'a, R: for<'r> Rootable<'r>>( &self, root: &'a DynamicRoot<R>, ) -> Result<&'a Root<'gc, R>, MismatchedRootSet>

Gets immutable access to the given root, or returns an error if the handle doesn’t belong to this root set.

pub fn contains<R: for<'r> Rootable<'r>>(&self, root: &DynamicRoot<R>) -> bool

Tests if the given handle belongs to this root set.

Trait Implementations

impl<'gc> Clone for DynamicRootSet<'gc>

fn clone(&self) -> DynamicRootSet<'gc>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'gc> Collect for DynamicRootSet<'gc>

fn trace(&self, cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

fn needs_trace() -> bool

where Self: Sized,

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

impl<'gc> Copy for DynamicRootSet<'gc>