Struct GcPointer

pub struct GcPointer<T: GcCell + ?Sized> { /* private fields */ }

GC collected smart-pointer. It allows T to be ?Sized for dynamic casts.

Implementations

impl<T: GcCell + ?Sized> GcPointer<T>

pub fn untyped(self) -> UntypedGcRef

Returns untyped GC ref from this pointer.

pub fn ptr_eq<U: GcCell + ?Sized>(this: &Self, other: &GcPointer<U>) -> bool

Pointer equality.

pub fn as_dyn(self) -> GcPointer<dyn GcCell>

Casts T back to `dyn GcCell.

pub fn is<U: Trace + Finalize<U> + GcCell + GCInfoTrait<U>>(self) -> bool

Check if this GC pointer stores U.

pub fn get_dyn(&self) -> &dyn GcCell

Get reference to dyn GcCell

pub fn get_dyn_mut(&mut self) -> &mut dyn GcCell

Get mutable reference to dyn GcCell

pub unsafe fn downcast_unchecked<U: GcCell>(self) -> GcPointer<U>

Unchecked downcast to U.

pub fn downcast<U: Trace + Finalize<U> + GcCell + GCInfoTrait<U>>( self, ) -> Option<GcPointer<U>>

Checked downcast to type U.

Trait Implementations

impl<T: GcCell + ?Sized> Clone for GcPointer<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: GcCell + Debug> Debug for GcPointer<T>

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

Formats the value using the given formatter.

impl<T: GcCell> Deref for GcPointer<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: GcCell> DerefMut for GcPointer<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: GcCell + Display> Display for GcPointer<T>

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

Formats the value using the given formatter.

impl<T: GcCell> GcCell for GcPointer<T>

fn compute_size(&self) -> usize

Used when object has dynamic size i.e arrays

fn type_name(&self) -> &'static str

impl<T: GcCell> PartialEq for GcPointer<T>

fn eq(&self, other: &Self) -> 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: GcCell + ?Sized> Pointer for GcPointer<T>

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

Formats the value using the given formatter.

impl<T: GcCell + Trace> TraceTrait for GcPointer<T>

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: GcCell + ?Sized> Copy for GcPointer<T>

impl<T: GcCell> Eq for GcPointer<T>