Struct compact_arena::TinyArena

pub struct TinyArena<'tag, T> { /* fields omitted */ }

A "tiny" arena containing up to 65536 elements. This variant only works with types implementing Default.

You will likely use this via the in_tiny_arena function.

Methods

impl<'tag, T: Copy + Clone + Default> TinyArena<'tag, T>

pub unsafe fn new(tag: InvariantLifetime<'tag>) -> TinyArena<'tag, T>

create a new TinyArena. Don't do this manually. Use the in_tiny_arena macro instead.

Safety

The whole tagged indexing trick relies on the 'tag you give to this constructor. You must never use this value in another arena, lest you might be able to mix up the indices of the two, which could lead to out of bounds access and thus Undefined Behavior!

pub fn try_add(&mut self, item: T) -> Result<Idx16<'tag>, CapacityExceeded<T>>

Add an item to the arena, get an index or CapacityExceeded back.

pub fn add(&mut self, item: T) -> Idx16<'tag>

Add an item to the arena, get an index back

Trait Implementations

impl<'tag, T> Index<Idx<'tag, u16>> for TinyArena<'tag, T>

type Output = T

The returned type after indexing.

fn index(&self, i: Idx16<'tag>) -> &T

Performs the indexing (container[index]) operation.

impl<'tag, T> IndexMut<Idx<'tag, u16>> for TinyArena<'tag, T>

fn index_mut(&mut self, i: Idx16<'tag>) -> &mut T

Performs the mutable indexing (container[index]) operation.