Struct gluon_vm::gc::GcPtr

pub struct GcPtr<T: ?Sized>(_);

A pointer to a garbage collected value.

It is only safe to access data through a GcPtr if the value is rooted (stored in a place where the garbage collector will find it during the mark phase).

Implementations

impl<T: ?Sized> GcPtr<T>

pub unsafe fn as_mut(&mut self) -> &mut T

Unsafe as it is up to the caller to ensure that this pointer is not referenced somewhere else

pub unsafe fn from_raw(ptr: *const T) -> GcPtr<T>

Unsafe as ptr must have been allocted by this garbage collector

pub fn generation(&self) -> Generation

pub fn poly_tag(&self) -> Option<&InternedStr>

pub fn field_map(&self) -> &FnvMap<InternedStr, VmIndex>

pub fn field_names(&self) -> &Arc<[InternedStr]>

pub fn ptr_eq(&self, other: &GcPtr<T>) -> bool

pub unsafe fn unrooted(&self) -> Self

pub fn as_lifetime(&self) -> &()

pub unsafe fn cast<U>(ptr: Self) -> GcPtr<U>

impl<'a, T: Trace + Send + Sync + 'a> GcPtr<T>

pub fn as_trace(self) -> GcPtr<dyn Trace + Send + Sync + 'a>

Coerces self to a Trace trait object

impl GcPtr<str>

pub fn as_trace_string(self) -> GcPtr<dyn Trace + Send + Sync>

Coerces self to a Trace trait object

impl GcPtr<ValueStr>

pub fn from_utf8(
    array: GcRef<'_, ValueArray>
) -> Result<GcRef<'_, ValueStr>, ()>

pub unsafe fn from_utf8_unchecked(array: GcPtr<ValueArray>) -> GcPtr<ValueStr>

Trait Implementations

impl<T: ?Sized> Borrow<T> for GcPtr<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized> CloneUnrooted for GcPtr<T>

type Value = Self

unsafe fn clone_unrooted(&self) -> Self

Creates a clone of the value that is not rooted. To ensure safety the value must be forgotten or rooted before the next garbage collection

impl<T: ?Sized> CopyUnrooted for GcPtr<T>

unsafe fn copy_unrooted(&self) -> Self

impl<T: ?Sized + Debug> Debug for GcPtr<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for GcPtr<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'de, 'gc, T> DeserializeState<'de, DeSeed<'gc>> for GcPtr<T> where
    T: Trace + PostDeserialize + 'static,
    T: DeserializeState<'de, DeSeed<'gc>>, 

fn deserialize_state<D>(
    seed: &mut DeSeed<'gc>,
    deserializer: D
) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserializes Self using seed and the deserializer

impl<'de, 'gc> DeserializeState<'de, DeSeed<'gc>> for GcPtr<ValueStr>

fn deserialize_state<D>(
    seed: &mut DeSeed<'gc>,
    deserializer: D
) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserializes Self using seed and the deserializer

impl<T: ?Sized + Display> Display for GcPtr<T>

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

Formats the value using the given formatter.

impl<T: ?Sized + Eq> Eq for GcPtr<T>

impl<'gc> From<&'gc GcPtr<Box<dyn Userdata + 'static>>> for Variants<'gc>

fn from(v: &'gc GcPtr<Box<dyn Userdata>>) -> Self

Performs the conversion.

impl<'gc> From<&'gc GcPtr<ClosureData>> for Variants<'gc>

fn from(v: &'gc GcPtr<ClosureData>) -> Self

Performs the conversion.

impl<'gc> From<&'gc GcPtr<DataStruct>> for Variants<'gc>

fn from(v: &'gc GcPtr<DataStruct>) -> Self

Performs the conversion.

impl<'gc> From<&'gc GcPtr<ExternFunction>> for Variants<'gc>

fn from(v: &'gc GcPtr<ExternFunction>) -> Self

Performs the conversion.

impl<'gc> From<&'gc GcPtr<PartialApplicationData>> for Variants<'gc>

fn from(v: &'gc GcPtr<PartialApplicationData>) -> Self

Performs the conversion.

impl<'gc> From<&'gc GcPtr<Thread>> for Variants<'gc>

fn from(v: &'gc GcPtr<Thread>) -> Self

Performs the conversion.

impl<'gc> From<&'gc GcPtr<ValueArray>> for Variants<'gc>

fn from(v: &'gc GcPtr<ValueArray>) -> Self

Performs the conversion.

impl<'gc> From<&'gc GcPtr<ValueStr>> for Variants<'gc>

fn from(v: &'gc GcPtr<ValueStr>) -> Self

Performs the conversion.

impl From<GcPtr<Box<dyn Userdata + 'static>>> for Value

fn from(v: GcPtr<Box<dyn Userdata>>) -> Value

Performs the conversion.

impl From<GcPtr<ClosureData>> for Value

fn from(v: GcPtr<ClosureData>) -> Value

Performs the conversion.

impl From<GcPtr<DataStruct>> for Value

fn from(v: GcPtr<DataStruct>) -> Value

Performs the conversion.

impl From<GcPtr<ExternFunction>> for Value

fn from(v: GcPtr<ExternFunction>) -> Value

Performs the conversion.

impl From<GcPtr<PartialApplicationData>> for Value

fn from(v: GcPtr<PartialApplicationData>) -> Value

Performs the conversion.

impl From<GcPtr<Thread>> for Value

fn from(v: GcPtr<Thread>) -> Value

Performs the conversion.

impl From<GcPtr<ValueArray>> for Value

fn from(v: GcPtr<ValueArray>) -> Value

Performs the conversion.

impl From<GcPtr<ValueStr>> for Value

fn from(v: GcPtr<ValueStr>) -> Value

Performs the conversion.

impl<T: ?Sized> From<OwnedPtr<T>> for GcPtr<T>

fn from(ptr: OwnedPtr<T>) -> GcPtr<T>

Freezes self into a shared pointer

impl<T: ?Sized + Hash> Hash for GcPtr<T>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T: ?Sized + Ord> Ord for GcPtr<T>

fn cmp(&self, other: &GcPtr<T>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ?Sized + PartialEq> PartialEq<GcPtr<T>> for GcPtr<T>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ?Sized + PartialOrd> PartialOrd<GcPtr<T>> for GcPtr<T>

fn partial_cmp(&self, other: &GcPtr<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized + Send + Sync> Send for GcPtr<T>

impl Serialize for GcPtr<ValueStr>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T, Seed> SerializeState<Seed> for GcPtr<T> where
    T: SerializeState<Seed>,
    Seed: AsRef<NodeToId>, 

fn serialize_state<S>(
    &self,
    serializer: S,
    seed: &Seed
) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serializes self

impl<T> Shared for GcPtr<T>

fn unique(&self) -> bool

fn as_ptr(&self) -> *const ()

impl<T: ?Sized + Send + Sync> Sync for GcPtr<T>

impl<T: ?Sized> Trace for GcPtr<T> where
    T: Trace, 

When traversing a GcPtr we need to mark it

unsafe fn root(&mut self)

unsafe fn unroot(&mut self)

fn trace(&self, gc: &mut Gc)