Struct wasmtime_runtime::TypedGcRef

pub struct TypedGcRef<T> { /* private fields */ }

A GC reference to a heap object of concrete type T.

Create typed GC refs via VMGcRef::into_typed and VMGcRef::as_typed, as well as via their unchecked equivalents VMGcRef::into_typed_unchecked and VMGcRef::as_typed_unchecked.

Implementations

impl<T> TypedGcRef<T>

where T: GcHeapObject,

pub fn clone(&self, gc_store: &mut GcStore) -> Self

Clone this VMGcRef, running any GC barriers as necessary.

pub fn drop(self, gc_store: &mut GcStore)

Explicitly drop this GC reference, running any GC barriers as necessary.

pub fn unchecked_copy(&self) -> Self

Copy this GC reference without running the GC’s clone barriers.

Prefer calling clone(&mut GcStore) instead! This is mostly an internal escape hatch for collector implementations.

Failure to run GC barriers when they would otherwise be necessary can lead to leaks, panics, and wrong results. It cannot lead to memory unsafety, however.

impl<T> TypedGcRef<T>

pub fn as_untyped(&self) -> &VMGcRef

Get the untyped version of this GC reference.

Trait Implementations

impl<T: Debug> Debug for TypedGcRef<T>

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

Formats the value using the given formatter.

impl<T> From<TypedGcRef<T>> for VMGcRef

fn from(value: TypedGcRef<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for TypedGcRef<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for TypedGcRef<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Eq> Eq for TypedGcRef<T>

impl<T> StructuralPartialEq for TypedGcRef<T>