Struct EntityStorage 

pub struct EntityStorage<T, const INLINE: usize = 1> { /* private fields */ }

EntityStorage provides an abstraction over storing IR entities in an crate::Operation.

Specifically, it provides an abstraction for storing IR entities in a flat vector, while retaining the ability to semantically group the entities, access them by group or individually, and grow or shrink the group or overall set.

The implementation expects the types stored in it to implement the StorableEntity trait, which provides it the ability to ensure the entity is kept up to date with its position in the set. Additionally, it ensures that removing an entity will unlink that entity from any dependents or dependencies that it needs to maintain links for.

Users can control the number of entities stored inline via the INLINE const parameter. By default, only a single entity is stored inline, but sometimes more may be desired if you know that a particular entity always has a particular cardinality.

Implementations

impl<T, const INLINE: usize> EntityStorage<T, INLINE>

pub fn is_empty(&self) -> bool

Returns true if there are no items in storage.

pub fn len(&self) -> usize

Returns the total number of items in storage.

pub fn num_groups(&self) -> usize

Returns the number of groups with allocated storage.

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

Get an iterator over all of the items in storage

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

Get a mutable iterator over all of the items in storage

pub fn groups(&self) -> impl Iterator<Item = EntityRange<'_, T>> + '_

Returns an iterator over the groups in storage

impl<T: StorableEntity, const INLINE: usize> EntityStorage<T, INLINE>

pub fn empty_mut(&mut self) -> EntityRangeMut<'_, T, INLINE>

Get an empty EntityRangeMut derived from this storage

pub fn push(&mut self, item: T)

Push an item to the last group

pub fn extend<I>(&mut self, items: I)

where I: IntoIterator<Item = T>,

Extend the last group with items

pub fn push_group(&mut self, items: impl IntoIterator<Item = T>) -> usize

Push items as a new group, and return the group index

pub fn push_to_group(&mut self, group: usize, item: T)

Push item to the specified group

pub fn extend_group<I>(&mut self, group: usize, items: I)

where I: IntoIterator<Item = T>,

Pushes items to the given group, creating it if necessary, and allocating any intervening implied groups if they have not been created it.

pub fn clear(&mut self)

Clear all items in storage

pub fn all(&self) -> EntityRange<'_, T>

Get all the items in storage

pub fn group(&self, group: usize) -> EntityRange<'_, T>

Get an EntityRange covering items in the specified group

pub fn group_mut(&mut self, group: usize) -> EntityRangeMut<'_, T, INLINE>

Get an EntityRangeMut covering items in the specified group

Trait Implementations

impl<T: Debug, const INLINE: usize> Debug for EntityStorage<T, INLINE>

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

Formats the value using the given formatter.

impl<T, const INLINE: usize> Default for EntityStorage<T, INLINE>

fn default() -> Self

Returns the “default value” for a type.

impl<T, const INLINE: usize> Index<usize> for EntityStorage<T, INLINE>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const INLINE: usize> IndexMut<usize> for EntityStorage<T, INLINE>

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

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