Struct ContiguousArena 

pub struct ContiguousArena<Idx, T> { /* private fields */ }

This is a Vec behind a generational arena.

The goal of this structure is to have unique identifiers for elements stored contiguously on a Vec.

Implementations

impl<Idx, T> ContiguousArena<Idx, T>

pub fn new() -> Self

Creates a new empty arena.

pub fn get_from_contiguous_index(&self, index: usize) -> Option<(&T, Idx)>

where Idx: From<ContiguousArenaIndex>,

Get an element from its position on the contiguous array.

pub fn len(&self) -> usize

The number of objects on this arena.

pub fn get(&self, handle: Idx) -> Option<&T>

where Idx: Into<ContiguousArenaIndex>,

Gets a reference to the object identified by handle.

pub fn get_mut(&mut self, handle: Idx) -> Option<&mut T>

where Idx: Into<ContiguousArenaIndex>,

Gets a mutable reference to the object identified by handle.

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

Gets references to all the objects on this set.

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

Gets mutable references to all the objects on this set.

pub fn iter<'a>(&'a self) -> impl Iterator<Item = (Idx, &'a T)> + 'a

where Idx: From<ContiguousArenaIndex>,

Iter through all the objects as well as their handle.

pub fn as_slice(&self) -> &[T]

Retrieves the set of objects as a slice.

pub fn as_mut_slice(&mut self) -> &mut [T]

Retrieves the set of objects as a mutable slice.

pub fn insert(&mut self, object: T) -> Idx

where Idx: From<ContiguousArenaIndex>,

Insert an object into this set.

pub fn remove(&mut self, handle: Idx) -> Option<T>

where Idx: Into<ContiguousArenaIndex>,

Remove an object from this set.

Trait Implementations

impl<Idx, T> AsMut<[T]> for ContiguousArena<Idx, T>

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Idx, T> AsRef<[T]> for ContiguousArena<Idx, T>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<Idx: Clone, T: Clone> Clone for ContiguousArena<Idx, T>

fn clone(&self) -> ContiguousArena<Idx, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Idx: Into<ContiguousArenaIndex>, T> Index<Idx> for ContiguousArena<Idx, T>

type Output = T

The returned type after indexing.

fn index(&self, i: Idx) -> &T

Performs the indexing (container[index]) operation.

impl<Idx: Into<ContiguousArenaIndex>, T> IndexMut<Idx> for ContiguousArena<Idx, T>

fn index_mut(&mut self, i: Idx) -> &mut T

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