Struct broom::Handle

pub struct Handle<T> { /* fields omitted */ }

A handle to a heap object.

Handle may be cheaply copied as is necessary to serve your needs. It's even legal for it to outlive the object it refers to, provided it is no longer used to access it afterwards.

Methods

impl<T> Handle<T>

pub unsafe fn get_unchecked(&self) -> &T

Get a reference to the object this handle refers to without checking any invariants.

You almost certainly do not want to use this function: consider Heap::get or Heap::get_unchecked instead; both are safer than this function.

The following invariants must be upheld by you, the responsible programmer:

• The object must still be alive (i.e: accessible from the heap it was created on)
• The object must not be mutably accessible elsewhere (i.e: has any live references to it) by any other part of the program. Immutable references are permitted. Other handles (i.e: Handle or Rooted are also permitted, provided they are not in use.
• That a garbage collection of the heap this object belongs to does not occur while the reference this function creates is live.

If any of these invariants are not upheld, undefined behaviour will result when using this function. If all are upheld, this function provides zero-cost access to underlying object.

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

Get a mutable reference to the object this handle refers to without checking any invariants.

You almost certainly do not want to use this function: consider [Heap::mutate] or [Heap::mutate_unchecked] instead; both are safer than this function.

The following invariants must be upheld by you, the responsible programmer:

• The object must still be alive (i.e: accessible from the heap it was created on)
• The object must not be accessible elsewhere (i.e: has any live references to it), either mutably or immutably, by any other part of the program. Other handles (i.e: Handle or Rooted are permitted, provided they are not in use.
• That a garbage collection of the heap this object belongs to does not occur while the reference this function creates is live.

If any of these invariants are not upheld, undefined behaviour will result when using this function. If all are upheld, this function provides zero-cost access to underlying object.

Trait Implementations

impl<T> AsRef<Handle<T>> for Handle<T>

fn as_ref(&self) -> &Handle<T>

Performs the conversion.

impl<T> AsRef<Handle<T>> for Rooted<T>

fn as_ref(&self) -> &Handle<T>

Performs the conversion.

impl<T> 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> Copy for Handle<T>

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

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

Formats the value using the given formatter.

impl<T> Eq for Handle<T>

impl<T> From<Rooted<T>> for Handle<T>

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

Performs the conversion.

impl<T> 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, 

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

impl<T> PartialEq<Handle<T>> for Handle<T>

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

fn trace(&self, tracer: &mut Tracer<O>)

Trace all child objects of this type.