Struct bevy_tasks::TaskPool

pub struct TaskPool { /* fields omitted */ }

A thread pool for executing tasks. Tasks are futures that are being automatically driven by the pool on threads owned by the pool.

Implementations

impl TaskPool

pub fn new() -> Self

Create a TaskPool with the default configuration.

pub fn thread_num(&self) -> usize

Return the number of threads owned by the task pool

pub fn scope<'scope, F, T>(&self, f: F) -> Vec<T> where
    F: FnOnce(&mut Scope<'scope, T>) + 'scope + Send,
    T: Send + 'static, 

Allows spawning non-`static futures on the thread pool. The function takes a callback, passing a scope object into it. The scope object provided to the callback can be used to spawn tasks. This function will await the completion of all tasks before returning.

This is similar to rayon::scope and crossbeam::scope

pub fn spawn<T>(
    &self,
    future: impl Future<Output = T> + Send + 'static
) -> impl Future<Output = T> + Send where
    T: Send + 'static, 

Spawns a static future onto the thread pool. The returned Task is a future. It can also be cancelled and "detached" allowing it to continue running without having to be polled by the end-user.

Trait Implementations

impl Clone for TaskPool

fn clone(&self) -> TaskPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for TaskPool

fn default() -> Self

Returns the "default value" for a type.