Struct memur::WeakArena

pub struct WeakArena { /* fields omitted */ }

A weak Arena reference that holds a pointer to valid memory until dropped.

As long as the original strong Arena is alive, this reference can be upgraded to Arena. If the Arena is no longer alive, the memory can no longer be mutated, and the drop functions for all root objects in the Arena are already executed.

However, if your structure does not need to be dropped (i.e. bunch of bytes), the bytes can be safely accessed as long as you hold the WeakArena reference, even if is_alive returns false.

The WeakArena, like Arena, can not be shared between threads.

Implementations

impl WeakArena

pub fn is_alive(&self) -> bool

Returns true if drop functions for the arena structures were not yet executed (the Arena is not dropped).

pub unsafe fn upload_auto_drop<T>(
    &self,
    value: T
) -> Result<(*mut T, *const Option<DropItem>), UploadError>

Place item to arena and return a pointer to it, and also add drop function to drop list to drop this item when there are no remaining Arena instances.

pub unsafe fn upload_no_drop<T>(&self, value: T) -> Result<*mut T, UploadError>

Place item to arena and return a pointer to it, without adding a drop function.

pub unsafe fn upload_no_drop_bytes(
    &self,
    len: usize,
    value: impl Iterator<Item = u8>
) -> Result<*mut u8, UploadError>

Place a chunk of bytes to arena and return a pointer to the first byte.

pub fn arena(&self) -> Option<Arena>

Try to upgrade WeakArena to Arena.

Trait Implementations

impl Clone for WeakArena

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for WeakArena

fn drop(&mut self)

Executes the destructor for this type.