Struct Arena 

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

Implementations

impl<T> Arena<T>

pub const fn new() -> Self

Creates a new empty arena.

pub const fn with_capacity(initial_capacity: usize) -> Self

Creates a new empty arena with the specified initial capacity.

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

Allocates a new value in the arena and returns a mutable reference to it.

Example

use simple_arena::Arena;

let arena = Arena::new();
let a = arena.alloc(1);
assert_eq!(*a, 1);

pub fn len(&self) -> usize

Returns the number of elements in the arena. O(n) time complexity.

Example

use simple_arena::Arena;

let arena = Arena::new();
let a = arena.alloc(1);
let b = arena.alloc(2);
let c = arena.alloc(3);
assert_eq!(arena.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the arena is empty. This is faster than checking if len() == 0. O(1) time complexity.

pub fn into_vec(self) -> Vec<T>

Converts the arena into a vector consuming the arena.

Example

use simple_arena::Arena;

let arena = Arena::new();
let a = arena.alloc(1);
let b = arena.alloc(2);
let vec = arena.into_vec();

assert_eq!(vec, vec![1, 2]);