Struct gluon_vm::gc::GcPtr

pub struct GcPtr<T: ?Sized> { /* fields omitted */ }

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).

Methods

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<Vec<InternedStr>>

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

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

pub fn as_traverseable(self) -> GcPtr<dyn Traverseable + Send + Sync + 'a>

Coerces self to a Traverseable trait object

impl GcPtr<str>

pub fn as_traverseable_string(self) -> GcPtr<dyn Traverseable + Send + Sync>

Coerces self to a Traverseable trait object

Trait Implementations

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

When traversing a GcPtr we need to mark it

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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 + Ord> Ord for GcPtr<T>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

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

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

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

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

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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 + Debug> Debug for GcPtr<T>

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

Formats the value using the given formatter.

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> Borrow<T> for GcPtr<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.