Struct DropArena 

pub struct DropArena<T> { /* private fields */ }

Typed drop-honouring arena. See the module-level docs.

Implementations

impl<T> DropArena<T>

pub fn new() -> Self

Creates an empty arena. The first allocation triggers the allocation of an initial chunk holding 16 T slots.

pub fn with_chunk_capacity(chunk_capacity: usize) -> Self

Creates an empty arena whose chunks each hold chunk_capacity T slots.

A chunk_capacity of zero is silently clamped to 1.

Examples

use arena_lib::DropArena;

// Tightly-sized chunks — every alloc beyond the 4th opens a new chunk.
let arena = DropArena::<u32>::with_chunk_capacity(4);
for i in 0..4 {
    let _ = arena.alloc(i);
}
assert_eq!(arena.chunk_count(), 1);
let _ = arena.alloc(99);
assert_eq!(arena.chunk_count(), 2);

pub fn len(&self) -> usize

Total number of T values currently held across every chunk.

pub fn is_empty(&self) -> bool

Returns true when the arena holds no values.

pub fn chunk_count(&self) -> usize

Number of chunks currently held.

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

Allocates value and returns a unique reference to it.

The value is moved into a chunk; its destructor will run when the arena is dropped. Panics only if the global allocator itself fails.

Examples

use arena_lib::DropArena;

let arena = DropArena::<String>::new();
let s = arena.alloc(String::from("owned"));
assert_eq!(s.as_str(), "owned");

Trait Implementations

impl<T: Debug> Debug for DropArena<T>

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

Formats the value using the given formatter.

impl<T> Default for DropArena<T>

fn default() -> Self

Returns the “default value” for a type.