Struct SharedArena 

pub struct SharedArena<A: Allocator = Global>(/* private fields */);

A thread-safe bump arena (Send + Sync).

Share &SharedArena across threads (for example, one arena for a whole parallel compilation); every worker allocates into it and the results live for the shared borrow. For contention-free per-worker scratch, take a ScopedArena with scoped.

Implementations

impl SharedArena<Global>

pub const fn new() -> Self

Creates new arena allocator that uses global allocator to allocate memory chunks.

See SharedArena::new_in for using custom allocator.

pub const fn with_chunk_size(chunk_size: usize) -> Self

Creates new arena allocator that uses global allocator to allocate memory chunks. With this method you can specify initial chunk size.

See SharedArena::new_in for using custom allocator.

impl<A: Allocator> SharedArena<A>

pub const fn new_in(arena: A) -> Self

Creates new arena allocator that uses the given allocator to allocate memory chunks.

pub const fn with_chunk_size_in(chunk_size: usize, arena: A) -> Self

Creates a new, empty arena whose chunks are at least chunk_size bytes.

pub fn scoped(&self) -> ScopedArena<'_, A>

Returns a thread-local ScopedArena drawing from this arena.

Each worker in a parallel pass can take its own scope and allocate scratch without contending on the shared bump pointer.

pub fn reset(&mut self)

Frees every allocation at once, keeping the arena’s chunks for reuse.

Trait Implementations

impl<A: Allocator> Allocator for SharedArena<A>

fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Attempts to allocate a block of memory.

fn allocate_zeroed(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Behaves like allocate, but also ensures that the returned memory is zero-initialized.

unsafe fn deallocate(&self, pointer: NonNull<u8>, layout: Layout)

Deallocates the memory referenced by ptr.

unsafe fn grow( &self, pointer: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Attempts to extend the memory block.

unsafe fn grow_zeroed( &self, pointer: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Behaves like grow, but also ensures that the new contents are set to zero before being returned.

unsafe fn shrink( &self, pointer: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Attempts to shrink the memory block.

fn by_ref(&self) -> &Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Allocator.

impl Default for SharedArena

fn default() -> Self

Returns the “default value” for a type.