Struct ArenaRc

pub struct ArenaRc<T: ?Sized>(/* private fields */);

An equivalent to ArenaBox that holds onto a reference to the arena to allow it to have static lifetime, and implements Clone allowing it to be shared. Since it’s shared, you can’t get a mutable reference to it back without using Self::try_unwrap to get the inner ArenaStaticBox.

Implementations

impl<T: ?Sized> ArenaRc<T>

pub unsafe fn new_unchecked(arena: Arena, data: ArenaBox<'_, T>) -> ArenaRc<T>

Transforms the given ArenaBox into an ArenaRc with an owned reference to the given Arena, allowing for it to be used in 'static contexts.

Safety

The caller must ensure that the given ArenaBox is owned by this arena, or it may result in use-after-free.

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

Downgrades the given ArenaRc into an ArenaWeak.

pub fn try_unwrap(this: Self) -> Result<ArenaStaticBox<T>, Self>

Attempts to take ownership over the arena and data backing the given ArenaRc if there is only one strong reference held to it.

If there is only one strong reference, this returns an ArenaBox tied to the lifetime of the &mut Option<Arena> given, and places the arena in that space.

Trait Implementations

impl<T: Clone + ?Sized> Clone for ArenaRc<T>

fn clone(&self) -> ArenaRc<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for ArenaRc<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for ArenaRc<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> From<ArenaStaticBox<T>> for ArenaRc<T>

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

Converts to this type from the input type.