Struct bones_framework::lib::ecs::prelude::ComponentStore

pub struct ComponentStore<T>
where
    T: HasSchema,
{ /* private fields */ }

A typed wrapper around UntypedComponentStore.

Implementations

impl<T> ComponentStore<T>

where T: HasSchema,

pub fn into_untyped(self) -> UntypedComponentStore

Converts to the internal, untyped ComponentStore.

pub fn from_untyped(untyped: UntypedComponentStore) -> ComponentStore<T>

Creates a ComponentStore from an UntypedComponentStore.

Panics

Panics if the schema doesn’t match T.

pub fn insert(&mut self, entity: Entity, component: T) -> Option<T>

Inserts a component for the given Entity index. Returns the previous component, if any.

pub fn get(&self, entity: Entity) -> Option<&T>

Gets an immutable reference to the component of Entity.

pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>

Gets a mutable reference to the component of Entity.

pub fn get_mut_or_insert( &mut self, entity: Entity, f: impl FnOnce() -> T, ) -> &mut T

Get a mutable reference to component if it exists. Otherwise inserts T generated by calling parameter: f.

pub fn get_many_mut<const N: usize>( &mut self, entities: [Entity; N], ) -> [Option<&mut T>; N]

Get mutable references to the component data for multiple entities at the same time.

Panics

This will panic if the same entity is specified multiple times. This is invalid because it would mean you would have two mutable references to the same component data at the same time.

pub fn remove(&mut self, entity: Entity) -> Option<T>

Removes the component of Entity. Returns Some(T) if the entity did have the component. Returns None if the entity did not have the component.

pub fn get_single_with_bitset( &self, bitset: Rc<BitSetVec>, ) -> Result<&T, QuerySingleError>

Gets an immutable reference to the component if there is exactly one instance of it.

pub fn get_single_with_bitset_mut( &mut self, bitset: Rc<BitSetVec>, ) -> Result<&mut T, QuerySingleError>

Gets a mutable reference to the component if there is exactly one instance of it.

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

Iterates immutably over all components of this type. Very fast but doesn’t allow joining with other component types.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Iterates mutably over all components of this type. Very fast but doesn’t allow joining with other component types.

Trait Implementations

impl<T> Clone for ComponentStore<T>

where T: Clone + HasSchema,

fn clone(&self) -> ComponentStore<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> ComponentIterBitset<'a, T> for ComponentStore<T>

where T: HasSchema,

fn get_single_with_bitset( &self, bitset: Rc<BitSetVec>, ) -> Result<&T, QuerySingleError>

Gets an immutable reference to the component if there is exactly one instance of it.

fn get_single_mut_with_bitset( &mut self, bitset: Rc<BitSetVec>, ) -> Result<&mut T, QuerySingleError>

Gets a mutable reference to the component if there is exactly one instance of it.

fn iter_with_bitset( &self, bitset: Rc<BitSetVec>, ) -> Map<UntypedComponentBitsetIterator<'_>, for<'b> fn(_: SchemaRef<'b>) -> &'b T>

Iterates immutably over the components of this type where bitset indicates the indices of entities. Slower than iter() but allows joining between multiple component types.

fn iter_with_bitset_optional( &self, bitset: Rc<BitSetVec>, ) -> Map<UntypedComponentOptionalBitsetIterator<'_>, for<'b> fn(_: Option<SchemaRef<'b>>) -> Option<&'b T>>

Iterates immutably over the components of this type where bitset indicates the indices of entities where iterator returns an Option. None is returned for entities in bitset when Component is not in ComponentStore

fn iter_mut_with_bitset( &mut self, bitset: Rc<BitSetVec>, ) -> Map<UntypedComponentBitsetIteratorMut<'_>, for<'b> fn(_: SchemaRefMut<'b>) -> &'b mut T>

Iterates mutable over the components of this type where bitset indicates the indices of entities. Slower than iter() but allows joining between multiple component types.

fn iter_mut_with_bitset_optional( &mut self, bitset: Rc<BitSetVec>, ) -> Map<UntypedComponentOptionalBitsetIteratorMut<'_>, for<'b> fn(_: Option<SchemaRefMut<'b>>) -> Option<&'b mut T>>

Iterates mutably over the components of this type where bitset indicates the indices of entities where iterator returns an Option. None is returned for entities in bitset when Component is not in [ComponentStore

fn bitset(&self) -> &BitSetVec

Read the bitset containing the list of entites with this component type on it.

fn contains(&self, entity: Entity) -> bool

Check whether or not this component store has data for the given entity.

fn component_store(&self) -> &ComponentStore<T>

Get ComponentStore for usage with generic types implementing ComponentIterBitset.

impl<T> Default for ComponentStore<T>

where T: HasSchema,

fn default() -> ComponentStore<T>

Returns the “default value” for a type.

impl<T> TryFrom<UntypedComponentStore> for ComponentStore<T>

where T: HasSchema,

type Error = SchemaMismatchError

The type returned in the event of a conversion error.

fn try_from( untyped: UntypedComponentStore, ) -> Result<ComponentStore<T>, <ComponentStore<T> as TryFrom<UntypedComponentStore>>::Error>

Performs the conversion.