Struct System

pub struct System<R, Q, F>
where
    R: ResourceSet,
    Q: QuerySet,
    F: SystemFn<Resources = <R as ResourceSet>::PreparedResources, Queries = Q>,
{ /* private fields */ }

The concrete type which contains the system closure provided by the user. This struct should not be instantiated directly, and instead should be created using SystemBuilder.

Implements Schedulable which is consumable by the StageExecutor, executing the closure.

Also handles caching of archetype information in a BitSet, as well as maintaining the provided information about what queries this system will run and, as a result, its data access.

Queries are stored generically within this struct, and the SystemQuery types are generated on each run call, wrapping the world and providing the set to the user in their closure.

Trait Implementations

impl<R, Q, F> Runnable for System<R, Q, F>

where R: ResourceSet, Q: QuerySet, F: SystemFn<Resources = <R as ResourceSet>::PreparedResources, Queries = Q>,

fn name(&self) -> &SystemId

Gets the name of the system.

fn reads(&self) -> (&[ResourceTypeId], &[ComponentTypeId])

Gets the resources and component types read by the system.

fn writes(&self) -> (&[ResourceTypeId], &[ComponentTypeId])

Gets the resources and component types written by the system.

fn prepare(&mut self, world: &World)

Prepares the system for execution against a world.

fn accesses_archetypes(&self) -> &ArchetypeAccess

Gets the set of archetypes the system will access when run, as determined when the system was last prepared.

fn command_buffer_mut( &self, world: WorldId, ) -> Option<RefMut<'_, CommandBuffer>>

Gets the system’s command buffer.

unsafe fn run_unsafe(&mut self, world: &World, resources: &Resources)

Runs the system.

fn run(&mut self, world: &mut World, resources: &mut Resources)

Runs the system.