Struct muse_lang::runtime::value::Rooted

pub struct Rooted<T: CustomType + Trace>(/* private fields */);

A reference counted pointer to a garbage collected value.

Implementations

impl<T> Rooted<T>

where T: CustomType + Trace,

pub fn new<'guard>( value: T, guard: &impl AsRef<CollectionGuard<'guard>>, ) -> Self

Moves value into the garbage collector and returns a rooted reference to it.

pub const fn as_any_dynamic(&self) -> AnyDynamic

Returns a weak, typeless reference to this value.

pub const fn downgrade(&self) -> Dynamic<T>

Returns a weak reference to this value.

pub fn as_any_root(&self) -> AnyDynamicRoot

Returns this value as a typeless root reference.

pub fn into_any_root(self) -> AnyDynamicRoot

Returns this value as a typeless root reference.

Trait Implementations

impl<T: CustomType + Trace> AsRef<T> for Rooted<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: CustomType + Trace> Clone for Rooted<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Rooted<T>

where T: Debug + CustomType + Trace,

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

Formats the value using the given formatter.

impl<T: CustomType + Trace> Deref for Rooted<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Trace for Rooted<T>

where T: CustomType + Trace,

const MAY_CONTAIN_REFERENCES: bool = false

If true, this type may contain references and should have its trace() function invoked during the collector’s “mark” phase.

fn trace(&self, _tracer: &mut Tracer<'_>)

Traces all refrences that this value references.