Struct Rc 

pub struct Rc<T: RcObject> { /* private fields */ }

A reference-counted pointer to an object of type T.

When T implements Send and Sync, Rc<T> also implements these traits.

The pointer must be properly aligned. Since it is aligned, a tag can be stored into the unused least significant bits of the address. For example, the tag for a pointer to a sized type T should be less than (1 << align_of::<T>().trailing_zeros()).

Implementations

impl<T: RcObject> Rc<T>

pub fn null() -> Self

Constructs a null Rc pointer.

pub fn is_null(&self) -> bool

Returns true if the pointer is null ignoring the tag.

pub fn new(obj: T) -> Self

Constructs a new Rc by allocating a new reference-couned object.

pub fn new_many<const N: usize>(obj: T) -> [Self; N]

Constructs multiple Rcs that point to the same object, which is allocated as a new reference-counted object.

This method is more efficient than calling Rc::new once and cloning multiple times because it is sufficient to set the reference counter only once, avoiding expensive read-modify-write operations.

pub fn new_many_iter(obj: T, count: usize) -> NewRcIter<T>

Constructs an iterator that produces the Rcs that point to the same object, which is allocated as a new reference-counted object.

This method is more efficient than calling Rc::new once and cloning multiple times because it is sufficient to set the reference counter only once, avoiding expensive read-modify-write operations.

pub fn weak_many<const N: usize>(&self) -> [Weak<T>; N]

Constructs multiple Weaks that point to the current object.

This method is more efficient than calling Rc::downgrade multiple times because it is sufficient to set the reference counter only once, avoiding expensive read-modify-write operations.

pub fn tag(&self) -> usize

Returns the tag stored within the pointer.

pub fn with_tag(self, tag: usize) -> Self

Returns the same pointer, but tagged with tag. tag is truncated to be fit into the unused bits of the pointer to T.

pub fn finalize(self, guard: &Guard)

Consumes this pointer and release a strong reference count it was owning.

This method is more efficient than just Droping the pointer. The Drop method checks whether the current thread is pinned and pin the thread if it is not. However, this method skips that procedure as it already requires Guard as an argument.

pub fn downgrade(&self) -> Weak<T>

Creates a Weak pointer by incrementing the weak reference counter.

pub fn snapshot<'g>(&self, guard: &'g Guard) -> Snapshot<'g, T>

Creates a Snapshot pointer to the same object.

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

Dereferences the pointer and returns an immutable reference.

It does not check whether the pointer is null.

Safety

The pointer must be a valid memory location to dereference.

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

Dereferences the pointer and returns a mutable reference.

It does not check whether the pointer is null.

Safety

The pointer must be a valid memory location to dereference and other threads must not have references to the object.

pub fn as_ref(&self) -> Option<&T>

Dereferences the pointer and returns an immutable reference if it is not null.

pub unsafe fn as_mut(&mut self) -> Option<&mut T>

Dereferences the pointer and returns a mutable reference if it is not null.

Safety

Other threads must not have references to the object.

pub fn ptr_eq(&self, other: &Self) -> bool

Returns true if the two pointer values, including the tag values set by with_tag, are identical.

Trait Implementations

impl<T: RcObject> Clone for Rc<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: RcObject + Debug> Debug for Rc<T>

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

Formats the value using the given formatter.

impl<T: RcObject> Default for Rc<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: RcObject> Drop for Rc<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: RcObject> From<&Rc<T>> for AtomicRc<T>

fn from(value: &Rc<T>) -> Self

Converts to this type from the input type.

impl<T: RcObject> From<&Rc<T>> for AtomicWeak<T>

fn from(value: &Rc<T>) -> Self

Converts to this type from the input type.

impl<T: RcObject> From<Rc<T>> for AtomicRc<T>

fn from(value: Rc<T>) -> Self

Converts to this type from the input type.

impl<'g, T: RcObject> From<Snapshot<'g, T>> for Rc<T>

fn from(value: Snapshot<'g, T>) -> Self

Converts to this type from the input type.

impl<T: RcObject + Hash> Hash for Rc<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: RcObject + Ord> Ord for Rc<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: RcObject + PartialEq> PartialEq for Rc<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: RcObject + PartialOrd> PartialOrd for Rc<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: RcObject> Pointer for Rc<T>

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

Formats the value using the given formatter.

impl<T: RcObject + Eq> Eq for Rc<T>

impl<T: RcObject + Send + Sync> Send for Rc<T>

impl<T: RcObject + Send + Sync> Sync for Rc<T>