Struct GcPtr 

pub struct GcPtr(/* private fields */);

A GcPtr is what you interact with outside of the allocator. It is a pointer to a piece of memory that points to the actual data stored in memory.

This creates an indirection that must be followed to get to the actual data of the object. Note that the GcPtr must therefore be pinned in memory whereas the contained memory pointer may change.

Trait Implementations

impl Clone for GcPtr

fn clone(&self) -> GcPtr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GcPtr

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

Formats the value using the given formatter.

impl From<*const *mut c_void> for GcPtr

fn from(ptr: *const *mut c_void) -> GcPtr

Converts to this type from the input type.

impl From<*const ObjectInfo> for GcPtr

fn from(info: *const ObjectInfo) -> GcPtr

Converts to this type from the input type.

impl From<*mut ObjectInfo> for GcPtr

fn from(info: *mut ObjectInfo) -> GcPtr

Converts to this type from the input type.

impl<G> From<GcRootPtr<G>> for GcPtr

where G: GcRuntime,

fn from(ptr: GcRootPtr<G>) -> GcPtr

Converts to this type from the input type.

impl From<NonNull<ObjectInfo>> for GcPtr

fn from(info: NonNull<ObjectInfo>) -> GcPtr

Converts to this type from the input type.

impl HasIndirectionPtr for GcPtr

unsafe fn deref<T>(&self) -> *const T

Returns a pointer to the referenced memory.

unsafe fn deref_mut<T>(&mut self) -> *mut T

Returns a mutable pointer to the referenced memory.

impl Hash for GcPtr

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GcPtr

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GcPtr

fn eq(&self, other: &GcPtr) -> 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 PartialOrd for GcPtr

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for GcPtr

impl Eq for GcPtr

impl Send for GcPtr

A GcPtr is thread safe.

impl StructuralPartialEq for GcPtr

impl Sync for GcPtr