Struct Handle

pub struct Handle<T: Trace + ?Sized> { /* private fields */ }

Wraps GC heap pointer.

GC thing pointers on the heap must be wrapped in a Handle<T>

Implementations

impl<T: Trace + Sized> Handle<T>

pub fn get(&self) -> &T

pub fn get_mut(&mut self) -> &mut T

Returns mutable reference to rooted value

Safety

Rust semantics doesn’t allow two mutable references at the same time and this function is safe as long as you have only one mutable reference.

If you want to be 100% sure that you don’t have two or more mutable references at the same time please use Heap<RefCell<T>>

Trait Implementations

impl<T: Trace> Clone for Handle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Trace + Debug> Debug for Handle<T>

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

Formats the value using the given formatter.

impl<T: Traceable> DerefMut for Handle<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Trace + Display> Display for Handle<T>

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

Formats the value using the given formatter.

impl<T: Trace> Finalizer for Handle<T>

fn finalize(&mut self)

impl<T: Trace + ?Sized> From<&Rooted<T>> for Handle<T>

fn from(x: &Rooted<T>) -> Self

Converts to this type from the input type.

impl<T: Trace + ?Sized> From<Rooted<T>> for Handle<T>

fn from(x: Rooted<T>) -> Self

Converts to this type from the input type.

impl<T: Trace + Hash> Hash for Handle<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: Trace + Sized + 'static> HeapTrait for Handle<T>

fn copy_to(&self, addr: Address)

fn mark(&self)

fn unmark(&self)

fn get_fwd(&self) -> Address

fn set_fwd(&self, fwd: Address)

fn addr(&self) -> Address

fn is_marked(&self) -> bool

fn inner(&self) -> *mut HeapInner<dyn Trace>

impl<T: Trace + Ord> Ord for Handle<T>

fn cmp(&self, other: &Self) -> 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<T: Trace + PartialEq> PartialEq for Handle<T>

fn eq(&self, other: &Self) -> 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<T: Trace + PartialOrd> PartialOrd for Handle<T>

fn partial_cmp(&self, other: &Self) -> 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<T: Traceable> Deref for Handle<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Trace> Copy for Handle<T>

impl<T: Trace + Eq> Eq for Handle<T>