Struct atomic_arena::Arena

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

A container of items that can be accessed via a Key.

Implementations

impl<T> Arena<T>

pub fn new(capacity: usize) -> Self

Creates a new Arena with enough space for capacity number of items.

pub fn controller(&self) -> Controller

Returns a Controller for this Arena.

pub fn capacity(&self) -> usize

Returns the total capacity for this Arena.

pub fn len(&self) -> usize

Returns the number of items currently in the Arena.

pub fn is_empty(&self) -> bool

Returns true if the Arena is currently empty.

pub fn insert_with_key(
    &mut self,
    key: Key,
    data: T
) -> Result<(), InsertWithKeyError>

Tries to insert an item into the Arena with a previously reserved Key.

pub fn insert(&mut self, data: T) -> Result<Key, ArenaFull>

Tries to reserve a Key, and, if successful, inserts an item into the Arena with that Key and returns the Key.

pub fn remove(&mut self, key: Key) -> Option<T>

If the Arena contains an item with the given Key, removes it from the Arena and returns Some(item). Otherwise, returns None.

pub fn get(&self, key: Key) -> Option<&T>

Returns a shared reference to the item in the Arena with the given Key if it exists. Otherwise, returns None.

pub fn get_mut(&mut self, key: Key) -> Option<&mut T>

Returns a mutable reference to the item in the Arena with the given Key if it exists. Otherwise, returns None.

pub fn retain(&mut self, f: impl FnMut(&T) -> bool)

Retains only the elements specified by the predicate.

In other words, remove all elements e such that f(&e) returns false.

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

Returns an iterator over shared references to the items in the Arena.

The most recently added items will be visited first.

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

Returns an iterator over mutable references to the items in the Arena.

The most recently added items will be visited first.

pub fn drain_filter<F: FnMut(&T) -> bool>(
    &mut self,
    filter: F
) -> DrainFilter<'_, T, F>

Returns an iterator that removes and yields all elements for which filter(&element) returns true.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Key> for Arena<T>

fn index_mut(&mut self, key: Key) -> &mut Self::Output

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

impl<'a, T> IntoIterator for &'a Arena<T>

type Item = (Key, &'a T)

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Arena<T>

type Item = (Key, &'a mut T)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.