Struct shred::Dispatcher

pub struct Dispatcher<'a, 'b> { /* private fields */ }

The dispatcher struct, allowing systems to be executed in parallel.

Implementations

impl<'a, 'b> Dispatcher<'a, 'b>

pub fn setup(&mut self, world: &mut World)

Sets up all the systems which means they are gonna add default values for the resources they need.

pub fn dispose(self, world: &mut World)

Calls the dispose method of all systems and allows them to release external resources. It is common this method removes components and / or resources from the World which are associated with external resources.

pub fn dispatch(&mut self, world: &World)

Dispatch all the systems with given resources and context and then run thread local systems.

This function automatically redirects to

• Dispatcher::dispatch_par in case it is supported
• Dispatcher::dispatch_seq otherwise

and runs dispatch_thread_local afterwards.

Please note that this method assumes that no resource is currently borrowed. If that’s the case, it panics.

pub fn dispatch_par(&mut self, world: &World)

Dispatches the systems (except thread local systems) in parallel given the resources to operate on.

This operation blocks the executing thread.

Only available with “parallel” feature enabled.

Please note that this method assumes that no resource is currently borrowed. If that’s the case, it panics.

pub fn dispatch_seq(&mut self, world: &World)

Dispatches the systems (except thread local systems) sequentially.

This is useful if parallel overhead is too big or the platform does not support multithreading.

Please note that this method assumes that no resource is currently borrowed. If that’s the case, it panics.

pub fn dispatch_thread_local(&mut self, world: &World)

Dispatch only thread local systems sequentially.

Please note that this method assumes that no resource is currently borrowed. If that’s the case, it panics.

pub fn max_threads(&self) -> usize

This method returns the largest amount of threads this dispatcher can make use of. This is mainly for debugging purposes so you can see how well your systems can make use of multi-threading.

Trait Implementations

impl<'a, 'b, 'c> RunNow<'a> for Dispatcher<'b, 'c>

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

Runs the system now.

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

Sets up World for a later call to run_now.

fn dispose(self: Box<Self>, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.