Struct Ref 

pub struct Ref<T> { /* private fields */ }

An alias for a referenced pointer

Implementations

impl<T> Ref<T>

pub fn as_ptr(&self) -> *const Arc<T>

pub fn count(&self) -> usize

Return the number of referrers to the underlying data

pub fn consume(self) -> Arc<T>

Consume this Ref<T> and grab the underlying Arc<T>

Consuming a Ref removes your ability to compare_exchange new data into the underlying AtomPtr with a previously held data reference. This function is different from take_clone (or take_copy) however in that it does block garbage collection.

impl<T: Copy> Ref<Option<T>>

pub fn is_some(&self) -> bool

Filter out references that internally contain None

impl<T: Copy> Ref<T>

pub fn take_copy(&self) -> T

Copy the underlying data without consuming the parent Ref<T>

Multiple copies can be taken before garbage collection is released (when the Ref<T> goes out of scope). Importantly copying the underlying data does not block gc.

For non-Copy structures see take_clone

impl<T: Clone> Ref<T>

pub fn take_clone(&self) -> T

Clone the underlying data structures without consuming the parent Ref<T>

Multiple clones can be made before garbage collection is released (when the Ref<T> goes out of scope). Importantly cloning the underlying data does not block gc.

For Copy structures see take_copy

Trait Implementations

impl<T> Deref for Ref<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.