Struct components_arena::Arena

pub struct Arena<C: Component + 'static> { /* private fields */ }

Unordered container with random access.

Implementations

impl<C: Component> Arena<C>

pub const fn new() -> Self where
    C::Alloc: Default, 

Creates an arena instance.

pub fn with_capacity(capacity: usize) -> Self where
    C::Alloc: Default, 

Creates an arena instance with the specified initial capacity.

impl<C: Component> Arena<C>

pub const fn new_in(alloc: C::Alloc) -> Self

Creates an arena instance.

pub fn with_capacity_in(capacity: usize, alloc: C::Alloc) -> Self

Creates an arena instance with the specified initial capacity.

pub fn into_items(self) -> ArenaItems<C>

Returns contained items packed in a special container. While arena itself is unique (i.e. non-clonable) object, this special container could be cloned.

pub fn items(&self) -> &ArenaItems<C>

Returns reference to contained items packed in a special container. While arena itself is unique (i.e. non-clonable) object, this special container could be cloned.

pub fn items_mut(&mut self) -> &mut ArenaItems<C>

Returns mutable reference to contained items packed in a (mostly read-only) special container. While arena itself is unique (i.e. non-clonable) object, this special container could be cloned.

pub fn insert<T>(&mut self, component: impl FnOnce(Id<C>) -> (C, T)) -> T

Place new component into the arena.

Examples

let mut arena = Arena::new();
let new_component_id = arena.insert(|id| (MyComponent { /* ... */ }, id));

pub fn remove(&mut self, id: Id<C>) -> C

Removes component with provided id.

The arena tries to detect invalid provided id (i.e. foreign, or previously dropped), and panics if such detection hits. But it is important to pay respect to the fact there is small probability that invalid id will not be intercepted.

Trait Implementations

impl<C: Component + 'static> Debug for Arena<C> where
    C: Debug,
    C::Alloc: Debug, 

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

Formats the value using the given formatter.

impl<C: Component> Default for Arena<C> where
    C::Alloc: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<C: Component> Index<Id<C>> for Arena<C>

type Output = C

The returned type after indexing.

fn index(&self, id: Id<C>) -> &C

Performs the indexing (container[index]) operation.

impl<C: Component> IndexMut<Id<C>> for Arena<C>

fn index_mut(&mut self, id: Id<C>) -> &mut C

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