Struct stack_graphs::arena::Arena

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

Manages the life cycle of instances of type T. You can allocate new instances of T from the arena. All of the instances managed by this arena will be dropped as a single operation when the arena itself is dropped.

Implementations

impl<T> Arena<T>

pub fn new() -> Arena<T>

Creates a new arena.

pub fn clear(&mut self)

Clear the arena, keeping underlying allocated capacity. After this, all previous handles into the arena are invalid.

pub fn add(&mut self, item: T) -> Handle<T>

Adds a new instance to this arena, returning a stable handle to it.

Note that we do not deduplicate instances of T in any way. If you add two instances that have the same content, you will get distinct handles for each one.

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

Dereferences a handle to an instance owned by this arena, returning a reference to it.

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

Dereferences a handle to an instance owned by this arena, returning a mutable reference to it.

pub fn iter_handles(&self) -> impl Iterator<Item = Handle<T>>

Returns an iterator of all of the handles in this arena. (Note that this iterator does not retain a reference to the arena!)

pub fn len(&self) -> usize

Returns the number of instances stored in this arena.

Trait Implementations

impl<T> Drop for Arena<T>

fn drop(&mut self)

Executes the destructor for this type.