Struct eko_gc::Gc

pub struct Gc<'gc, T: Trace + 'gc> { /* fields omitted */ }

A smart pointer to a value managed by a garbage-collector

This pointer can be created either by allocating a new garbage-collected value using the GcArena::alloc method or by cloning an existing Gc pointer with Gc::clone. This pointer can only be used during the lifetime of the corresponding garbage-collected arena (represented by the lifetime 'gc).

By default, a Gc pointer acts as a root for its value: as long as the Gc is on the stack its value is kept alive. A Gc is unrooted only when it is moved (transitively) inside another Gc.

Trait Implementations

impl<'gc, T: Trace> Trace for Gc<'gc, T>

unsafe fn mark(&self)

Marks the value in the GcBox as reachable.

The mark signal will be propagated further in the object graph unless the box was already marked (to avoid infinite loops on cycles, or redundant traversals).

unsafe fn root(&self)

Tags this Gc pointer as a root for its value.

unsafe fn unroot(&self)

Untags this Gc pointer as a root for its value.

impl<'gc, T: Trace + 'gc> Clone for Gc<'gc, T>

Creates a new Gc pointer for the same value.

It is recommended to use it as Gc::clone(&gc) instead of gc.clone() to avoid confusion with the clone method of the inner value.

fn clone(&self) -> Gc<'gc, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'gc, T: Trace> Drop for Gc<'gc, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'gc, T: Trace> Deref for Gc<'gc, T>

The Deref implementation allows to use the value's methods directly on the Gc pointer.

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'gc, T: Debug + Trace + 'gc> Debug for Gc<'gc, T>

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

Formats the value using the given formatter.