use crate::{ArchetypeComponent, Resources, TypeAccess, World}; use std::{any::TypeId, borrow::Cow}; /// Determines the strategy used to run the `run_thread_local` function in a [System] #[derive(Copy, Clone, Eq, PartialEq, Debug)] pub enum ThreadLocalExecution { Immediate, NextFlush, } #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)] pub struct SystemId(pub usize); impl SystemId { #[allow(clippy::new_without_default)] pub fn new() -> Self { SystemId(rand::random::()) } } /// An ECS system that can be added to a [Schedule](crate::Schedule) pub trait System: Send + Sync + 'static { type In; type Out; fn name(&self) -> Cow<'static, str>; fn id(&self) -> SystemId; fn update(&mut self, world: &World); fn archetype_component_access(&self) -> &TypeAccess; fn resource_access(&self) -> &TypeAccess; fn thread_local_execution(&self) -> ThreadLocalExecution; /// # Safety /// This might access World and Resources in an unsafe manner. This should only be called in one of the following contexts: /// 1. This system is the only system running on the given World and Resources across all threads /// 2. This system only runs in parallel with other systems that do not conflict with the `archetype_component_access()` or `resource_access()` unsafe fn run_unsafe( &mut self, input: Self::In, world: &World, resources: &Resources, ) -> Option; fn run( &mut self, input: Self::In, world: &mut World, resources: &mut Resources, ) -> Option { // SAFE: world and resources are exclusively borrowed unsafe { self.run_unsafe(input, world, resources) } } fn run_thread_local(&mut self, world: &mut World, resources: &mut Resources); fn initialize(&mut self, _world: &mut World, _resources: &mut Resources); }