Struct catalyst_entities::Arena

#[repr(transparent)]
pub struct Arena { /* private fields */ }

Arena is safe wrapper around Allocator that allows to allocate values that dont need dropping.

Implementations

impl Arena

pub fn new(allocator: Allocator) -> Self

Create new arena with given allocator.

pub fn alloc<T>(&self, value: T) -> &T

Allocate value in arena. Value must not need dropping which will be asserted at compile time.

pub fn alloc_slice<T>(&self, value: &[T]) -> &[T]

Analogous to alloc but for slices.

pub fn alloc_iter<T, I>(&self, iter: I) -> &[T] where I: IntoIterator<Item = T>, I::IntoIter: ExactSizeIterator,

Analogous to alloc_slice but for iterators.

pub fn alloc_byte_layout(&self, layout: Layout) -> &mut [u8]

More low level function that allocates sequence of arbitrary bytes compatible with passed layout.

pub fn clear(&mut self)

Clear arena, since all allocated values dont need dropping, we can just reset allocator. This function is safe since it requires mutable arena whitch implies all allocations are dropped.

pub fn into_allocator(self) -> Allocator

Get allocator from arena.

pub fn frame(&mut self) -> ArenaFrame<'_>

Get frame from arena. This creates checkpoint that can be used to rollback arena to state before frame was created. Rollback is performed implicitly when frame is dropped.

Trait Implementations

impl Default for Arena

fn default() -> Arena

Returns the “default value” for a type.

impl Send for Arena