Struct alloc::rc::UniqueRc

pub struct UniqueRc<T> {
    ptr: NonNull<RcBox<T>>,
    phantom: PhantomData<RcBox<T>>,
}

🔬This is a nightly-only experimental API. (unique_rc_arc #112566)

A uniquely owned Rc

This represents an Rc that is known to be uniquely owned – that is, have exactly one strong reference. Multiple weak pointers can be created, but attempts to upgrade those to strong references will fail unless the UniqueRc they point to has been converted into a regular Rc.

Because they are uniquely owned, the contents of a UniqueRc can be freely mutated. A common use case is to have an object be mutable during its initialization phase but then have it become immutable and converted to a normal Rc.

This can be used as a flexible way to create cyclic data structures, as in the example below.

#![feature(unique_rc_arc)]
use std::rc::{Rc, Weak, UniqueRc};

struct Gadget {
    #[allow(dead_code)]
    me: Weak<Gadget>,
}

fn create_gadget() -> Option<Rc<Gadget>> {
    let mut rc = UniqueRc::new(Gadget {
        me: Weak::new(),
    });
    rc.me = UniqueRc::downgrade(&rc);
    Some(UniqueRc::into_rc(rc))
}

create_gadget().unwrap();

An advantage of using UniqueRc over Rc::new_cyclic to build cyclic data structures is that Rc::new_cyclic’s data_fn parameter cannot be async or return a Result. As shown in the previous example, UniqueRc allows for more flexibility in the construction of cyclic data, including fallible or async constructors.

Fields

ptr: NonNull<RcBox<T>>

🔬This is a nightly-only experimental API. (unique_rc_arc #112566)

phantom: PhantomData<RcBox<T>>

🔬This is a nightly-only experimental API. (unique_rc_arc #112566)

Implementations

impl<T> UniqueRc<T>

pub fn new(value: T) -> Self

🔬This is a nightly-only experimental API. (unique_rc_arc #112566)

Creates a new UniqueRc

Weak references to this UniqueRc can be created with UniqueRc::downgrade. Upgrading these weak references will fail before the UniqueRc has been converted into an Rc. After converting the UniqueRc into an Rc, any weak references created beforehand will point to the new Rc.

pub fn downgrade(this: &Self) -> Weak<T>

🔬This is a nightly-only experimental API. (unique_rc_arc #112566)

Creates a new weak reference to the UniqueRc

Attempting to upgrade this weak reference will fail before the UniqueRc has been converted to a Rc using UniqueRc::into_rc.

pub fn into_rc(this: Self) -> Rc<T>

🔬This is a nightly-only experimental API. (unique_rc_arc #112566)

Converts the UniqueRc into a regular Rc

This consumes the UniqueRc and returns a regular Rc that contains the value that is passed to into_rc.

Any weak references created before this method is called can now be upgraded to strong references.

Trait Implementations

impl<T: Debug> Debug for UniqueRc<T>

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

Formats the value using the given formatter.

impl<T> Deref for UniqueRc<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for UniqueRc<T>

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

Mutably dereferences the value.

impl<T> Drop for UniqueRc<T>

fn drop(&mut self)

Executes the destructor for this type.