Struct GcRef

#[repr(C)]
pub struct GcRef<T> { /* private fields */ }

A typed garbage collected pointer to a value.

This is the equivalent of a garbage collected smart-pointer.

The smart pointer is simply a guarantee to the garbage collector that this points to a garbage collected object with the correct header, and not some arbitrary bits that you’ve decided to heap allocate.

Implementations

impl<T> GcRef<T>

pub fn into_raw(self) -> *const HeapObjectHeader

pub fn downcast(self) -> UntypedGcRef

Trait Implementations

impl<T> Clone for GcRef<T>

fn clone(&self) -> GcRef<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for GcRef<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for GcRef<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<GcRef<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for GcRef<T>

fn deref_mut(&mut self) -> &mut <GcRef<T> as Deref>::Target

Mutably dereferences the value.

impl<T> Display for GcRef<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> PartialEq for GcRef<T>

fn eq(&self, other: &GcRef<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Pointer for GcRef<T>

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

Formats the value using the given formatter.

impl<T> TraceTrait for GcRef<T>

where T: TraceTrait,

fn trace(&self, vis: &mut Visitor)

Function invoking the tracing for an object of type T.

extern "C" fn trace_(vis: *mut Visitor, this: *const u8)

trace_ method is used for C FFI safety.

fn get_trace_descriptor(this: *const u8) -> TraceDescriptor

Returns trace descriptor for type that implements this trait. Not recommended to override it.

impl<T> Copy for GcRef<T>

impl<T> Eq for GcRef<T>