Struct System

Source
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>
where R: for<'a> ResourceSet<'a>, Q: QuerySet, F: SystemFn<R, Q>,

Source§

fn name(&self) -> Option<&SystemId>

Gets the name of the system.
Source§

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

Gets the resources and component types read by the system.
Source§

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

Gets the resources and component types written by the system.
Source§

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

Prepares the system for execution against a world.
Source§

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>

Gets the system’s command buffer.
Source§

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

Runs the system. Read more
Source§

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

Runs the system.

Auto Trait Implementations§

§

impl<R, Q, F> Freeze for System<R, Q, F>
where Q: Freeze, F: Freeze,

§

impl<R, Q, F> !RefUnwindSafe for System<R, Q, F>

§

impl<R, Q, F> Send for System<R, Q, F>
where Q: Send, F: Send, R: Send,

§

impl<R, Q, F> Sync for System<R, Q, F>
where Q: Sync, F: Sync, R: Sync,

§

impl<R, Q, F> Unpin for System<R, Q, F>
where Q: Unpin, F: Unpin,

§

impl<R, Q, F> !UnwindSafe for System<R, Q, F>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Component for T
where T: 'static + Send + Sync,

Source§

type Storage = PackedStorage<T>

The storage type required to hold all instances of this component in a world.
Source§

impl<T> Downcast for T
where T: Any,

Source§

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>

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)

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)

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
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ParallelRunnable for T
where T: Runnable + Send + Sync,

Source§

impl<T> Resource for T
where T: 'static,