Struct shard_ecs::archetype_registry::ArchetypeRegistry

pub struct ArchetypeRegistry { /* private fields */ }

Stores all archetypes.

Implementations

impl ArchetypeRegistry

pub fn find_archetype(
    &self,
    archetype_descriptor: &ArchetypeDescriptor
) -> Option<&Archetype>

pub fn find_archetype_mut(
    &mut self,
    archetype_descriptor: &ArchetypeDescriptor
) -> Option<&mut Archetype>

pub fn find_or_create_archetype_adding_component(
    &mut self,
    source_archetype_index: u16,
    component_descriptor: &ComponentDescriptor
) -> Option<(&mut Archetype, u16, &mut Archetype)>

Returns mutable reference to source archetype and finds or creates a new archetype by adding the given component type as defined by component descriptor.

pub fn find_or_create_archetype_removing_component(
    &mut self,
    source_archetype_index: u16,
    component_descriptor: &ComponentDescriptor
) -> Option<(&mut Archetype, u16, &mut Archetype)>

Returns mutable reference to source archetype and finds or creates a new archetype by removing the given component type as defined by component descriptor.

pub fn find_or_create_archetype(
    &mut self,
    archetype_descriptor: &ArchetypeDescriptor
) -> Option<(u16, &mut Archetype)>

pub unsafe fn get_unchecked(&self, index: u16) -> &Archetype

Returns an archetype reference for the given index.

Safety

Index must not be out of bounds.

pub unsafe fn get_unchecked_mut(&mut self, index: u16) -> &mut Archetype

Returns a mutable archetype reference for the given index.

Safety

Index must not be out of bounds.

pub fn iter_components_matching<'a, G: ComponentGroup>(
    &'a self
) -> impl Iterator<Item = <G as ComponentGroup>::SliceRefTuple<'a>>

pub fn iter_components_matching_mut<'a, G: ComponentGroup>(
    &'a mut self
) -> impl Iterator<Item = <G as ComponentGroup>::SliceMutRefTuple<'a>>

pub fn iter_entity_components_matching<'a, G: ComponentGroup>(
    &'a self
) -> impl Iterator<Item = (&'a [Entity], <G as ComponentGroup>::SliceRefTuple<'a>)>

pub fn iter_entity_components_matching_mut<'a, G: ComponentGroup>(
    &'a mut self
) -> impl Iterator<Item = (&'a [Entity], <G as ComponentGroup>::SliceMutRefTuple<'a>)>

pub fn iter_filtered_components_matching<'a, G: ComponentGroup, F: Fn(&ArchetypeDescriptor) -> bool>(
    &'a self,
    filter_closure: F
) -> impl Iterator<Item = <G as ComponentGroup>::SliceRefTuple<'a>>

pub fn iter_filtered_components_matching_mut<'a, G: ComponentGroup, F: Fn(&ArchetypeDescriptor) -> bool>(
    &'a mut self,
    filter_closure: F
) -> impl Iterator<Item = <G as ComponentGroup>::SliceMutRefTuple<'a>>

pub fn iter_filtered_entity_components_matching<'a, G: ComponentGroup, F: Fn(&ArchetypeDescriptor) -> bool>(
    &'a self,
    filter_closure: F
) -> impl Iterator<Item = (&'a [Entity], <G as ComponentGroup>::SliceRefTuple<'a>)>

pub fn iter_filtered_entity_components_matching_mut<'a, G: ComponentGroup, F: Fn(&ArchetypeDescriptor) -> bool>(
    &'a mut self,
    filter_closure: F
) -> impl Iterator<Item = (&'a [Entity], <G as ComponentGroup>::SliceMutRefTuple<'a>)>

Trait Implementations

impl Debug for ArchetypeRegistry

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

Formats the value using the given formatter.

impl Default for ArchetypeRegistry

fn default() -> Self

Returns the “default value” for a type.

impl Index<u16> for ArchetypeRegistry

type Output = Archetype

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<u16> for ArchetypeRegistry

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

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