Struct Archetypes 

pub struct Archetypes { /* private fields */ }

Contains all the Archetypes and their metadata for a world.

This can be obtained in a handler by using the &Archetypes handler parameter.

world.add_handler(|_: Receiver<E>, archetypes: &Archetypes| {});

Implementations

impl Archetypes

pub fn empty(&self) -> &Archetype

Returns a reference to the empty archetype (The archetype with no components).

The empty archetype is always present, so this function is infallible.

pub fn get(&self, idx: ArchetypeIdx) -> Option<&Archetype>

Gets a reference to the archetype identified by the given ArchetypeIdx. Returns None if the index is invalid.

pub fn get_by_components( &self, components: &[ComponentIdx], ) -> Option<&Archetype>

Gets a reference to the archetype with the given set of components.

Returns None if there is no archetype with the given set of components or the given ComponentIdx slice is not sorted and deduplicated.

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

Returns an iterator over all archetypes in an arbitrary order.

pub fn len(&self) -> usize

Returns a count of the archetypes.

Trait Implementations

impl Debug for Archetypes

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

Formats the value using the given formatter.

impl HandlerParam for &Archetypes

type State = ()

Persistent data stored in the handler.

type This<'a> = &'a Archetypes

The type produced by this handler param. This must be the type of Self but with the lifetime of 'a.

fn init( _world: &mut World, _config: &mut HandlerConfig, ) -> Result<Self::State, InitError>

Initializes the handler using the input World and HandlerConfig.

unsafe fn get<'a>( _state: &'a mut Self::State, _info: &'a HandlerInfo, _event_ptr: EventPtr<'a>, _target_location: EntityLocation, world: UnsafeWorldCell<'a>, ) -> Self::This<'a>

Obtains a new instance of the handler parameter.

fn refresh_archetype(_state: &mut Self::State, _arch: &Archetype)

Refresh an archetype for this handler param. Called whenever Handler::refresh_archetype is called.

fn remove_archetype(_state: &mut Self::State, _arch: &Archetype)

Remove the given archetype for this handler param. Called whenever Handler::remove_archetype is called.

impl Index<ArchetypeIdx> for Archetypes

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

Panics if the index is invalid.

type Output = Archetype

The returned type after indexing.