Struct UntypedGcRef

#[repr(C)]
pub struct UntypedGcRef { /* private fields */ }

A untyped garbage collected pointer to a value, you can think of it as void* pointer but managed by GC.

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 UntypedGcRef

pub fn get(&self) -> *mut u8

Returns data part of GC object. That is part of allocation after heap object header.

pub fn is(&self, index: GCInfoIndex) -> bool

Returns true if object has the same index.

pub fn cast<T>(self) -> Option<GcRef<T>>

where T: GCInfoTrait<T> + TraceTrait + FinalizeTrait<T> + 'static,

Returns Some(T) if T::index() is the same as in this object.

pub unsafe fn cast_unchecked<T>(self) -> GcRef<T>

where T: GCInfoTrait<T> + TraceTrait + FinalizeTrait<T> + 'static,

Unchecked cast withouth verifying indexes.

Trait Implementations

impl Clone for UntypedGcRef

fn clone(&self) -> UntypedGcRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UntypedGcRef

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

Formats the value using the given formatter.

impl PartialEq for UntypedGcRef

fn eq(&self, other: &UntypedGcRef) -> 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 Pointer for UntypedGcRef

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

Formats the value using the given formatter.

impl TraceTrait for UntypedGcRef

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 Copy for UntypedGcRef

impl Eq for UntypedGcRef