Struct gluon_vm::gc::GcPtr

pub struct GcPtr<T: ?Sized> {
    // some 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>

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

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

Unsafe as ptr must have been allocted by this garbage collector

fn generation(&self) -> usize

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

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

Coerces self to a Traverseable trait object

impl GcPtr<str>

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

Coerces self to a Traverseable trait object

Trait Implementations

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

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

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

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

type Target = T

The resulting type after dereferencing

fn deref(&self) -> &T

The method called to dereference a value

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

fn borrow(&self) -> &T

Immutably borrows from an owned value.

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

impl<T: ?Sized + PartialEq> PartialEq 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 ==.

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

This method tests for !=.

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

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

This method returns an Ordering between self and other.

impl<T: ?Sized + PartialOrd> PartialOrd 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.

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

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

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

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

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

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

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

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

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

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> Traverseable for GcPtr<T> where T: Traverseable

When traversing a GcPtr we need to mark it

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