Struct evenio::component::Components

pub struct Components { /* private fields */ }

Contains metadata for all the components in a world.

This can be obtained in a system by using the &Components system parameter.

world.add_system(|_: Receiver<E>, components: &Components| {});

Implementations

impl Components

pub fn get(&self, id: ComponentId) -> Option<&ComponentInfo>

Gets the ComponentInfo of the given component. Returns None if the ID is invalid.

pub fn get_by_index(&self, idx: ComponentIdx) -> Option<&ComponentInfo>

Gets the ComponentInfo for a component using its ComponentIdx. Returns None if the index is invalid.

pub fn get_by_type_id(&self, type_id: TypeId) -> Option<&ComponentInfo>

Gets the ComponentInfo for a component using its TypeId. Returns None if the TypeId does not map to a component.

pub fn contains(&self, id: ComponentId) -> bool

Does the given component exist in the world?

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

Returns an iterator over all component infos.

Trait Implementations

impl Debug for Components

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

Formats the value using the given formatter.

impl Index<ComponentId> for Components

type Output = ComponentInfo

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<ComponentIdx> for Components

type Output = ComponentInfo

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<TypeId> for Components

type Output = ComponentInfo

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl SystemParam for &Components

type State = ()

Persistent data stored in the system.

type Item<'a> = &'a Components

The type produced by this system param. This is expected to be the type of Self but with the lifetime of 'a.

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

Initializes the system using the input World and Config.

unsafe fn get<'a>( _state: &'a mut Self::State, _info: &'a SystemInfo, _event_ptr: EventPtr<'a>, world: UnsafeWorldCell<'a> ) -> Self::Item<'a>

Obtain an instance of the system parameter. Called whenever the system is called.

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

Refresh an archetype for this system param. Called whenever System::refresh_archetype is called.

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

Remove the given archetype for this system param. Called whenever System::remove_archetype is called.