pub struct System<R, Q, F> { /* private fields */ }
Expand description
The concrete type which contains the system closure provided by the user. This struct should
not be constructed 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, as well as maintaining the provided information about what queries this system will run and, as a result, its data access.
Trait Implementations§
Source§impl<R, Q, F> Runnable for System<R, Q, F>
impl<R, Q, F> Runnable for System<R, Q, F>
Source§fn reads(&self) -> (&[ResourceTypeId], &[ComponentTypeId])
fn reads(&self) -> (&[ResourceTypeId], &[ComponentTypeId])
Gets the resources and component types read by the system.
Source§fn writes(&self) -> (&[ResourceTypeId], &[ComponentTypeId])
fn writes(&self) -> (&[ResourceTypeId], &[ComponentTypeId])
Gets the resources and component types written by the system.
Source§fn accesses_archetypes(&self) -> &ArchetypeAccess
fn accesses_archetypes(&self) -> &ArchetypeAccess
Gets the set of archetypes the system will access when run,
as determined when the system was last prepared.
Source§fn command_buffer_mut(&mut self, world: WorldId) -> Option<&mut CommandBuffer>
fn command_buffer_mut(&mut self, world: WorldId) -> Option<&mut CommandBuffer>
Gets the system’s command buffer.
Source§unsafe fn run_unsafe(&mut self, world: &World, resources: &UnsafeResources)
unsafe fn run_unsafe(&mut self, world: &World, resources: &UnsafeResources)
Runs the system. Read more
Auto Trait Implementations§
impl<R, Q, F> Freeze for System<R, Q, F>
impl<R, Q, F> !RefUnwindSafe for System<R, Q, F>
impl<R, Q, F> Send for System<R, Q, F>
impl<R, Q, F> Sync for System<R, Q, F>
impl<R, Q, F> Unpin for System<R, Q, F>
impl<R, Q, F> !UnwindSafe for System<R, Q, F>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Component for T
impl<T> Component for T
Source§type Storage = PackedStorage<T>
type Storage = PackedStorage<T>
The storage type required to hold all instances of this component in a world.
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more