Struct ArenaStaticBox

pub struct ArenaStaticBox<T: ?Sized> { /* private fields */ }

An equivalent to ArenaBox that holds onto a reference to the arena to allow it to have static lifetime.

Implementations

impl<T: ?Sized> ArenaStaticBox<T>

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

Transforms the given ArenaBox into an ArenaStaticBox 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 unwrap(this: Self, arena: &mut Option<Arena>) -> ArenaBox<'_, T>

Takes ownership over the arena and data backing the given ArenaStaticBox.

This returns an ArenaBox tied to the lifetime of the &mut Option<Arena> given, and places the arena in that space.

pub fn into_raw(this: Self) -> (NonNull<fdf_arena_t>, NonNull<T>)

Takes ownership of the arena and data backing the given ArenaStaticBox as raw pointers.

Note that while this is safe, care must be taken to ensure that the raw pointer to the data is not accessed after the arena pointer has been released.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> DerefMut for ArenaStaticBox<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably 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.

impl<T: 'static> IntoIterator for ArenaStaticBox<[T]>

type IntoIter = IntoIter<T, Arena>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Send for ArenaStaticBox<T>

where T: Send + ?Sized,

SAFETY: ArenaStaticBox impls Send and Sync if T impls them.

impl<T> Sync for ArenaStaticBox<T>

where T: Sync + ?Sized,