Struct thunderdome::Arena

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

Container that can have elements inserted into it and removed from it.

Indices use the Index type, created by inserting values with Arena::insert.

Implementations

impl<T> Arena<T>

pub fn new() -> Self

Construct an empty arena.

pub fn with_capacity(capacity: usize) -> Self

Construct an empty arena with space to hold exactly capacity elements without reallocating.

pub fn len(&self) -> usize

Return the number of elements contained in the arena.

pub fn capacity(&self) -> usize

Return the number of elements the arena can hold without allocating, including the elements currently in the arena.

pub fn is_empty(&self) -> bool

Returns whether the arena is empty.

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

Insert a new value into the arena, returning an index that can be used to later retrieve the value.

pub fn get(&self, index: Index) -> Option<&T>

Get an immutable reference to a value inside the arena by Index, returning None if the index is not contained in the arena.

pub fn get_mut(&mut self, index: Index) -> Option<&mut T>

Get a mutable reference to a value inside the arena by Index, returning None if the index is not contained in the arena.

pub fn remove(&mut self, index: Index) -> Option<T>

Remove the value contained at the given index from the arena, returning it if it was present.

pub fn iter(&self) -> Iter<'_, T>

Iterate over all of the indexes and values contained in the arena.

Iteration order is not defined.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Iterate over all of the indexes and values contained in the arena, with mutable access to each value.

Iteration order is not defined.

pub fn drain(&mut self) -> Drain<'_, T>

Returns an iterator that removes each element from the arena.

Iteration order is not defined.

If the iterator is dropped before it is fully consumed, any uniterated items will still be contained in the arena.

Trait Implementations

impl<T: Clone> Clone for Arena<T>

fn clone(&self) -> Arena<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Arena<T>

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

Formats the value using the given formatter.

impl<T> Default for Arena<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Index<Index> for Arena<T>

type Output = T

The returned type after indexing.

fn index(&self, index: Index) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Index> for Arena<T>

fn index_mut(&mut self, index: Index) -> &mut Self::Output

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

impl<T> IntoIterator for Arena<T>

type Item = (Index, T)

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.