Struct bevy::tasks::IoTaskPool

pub struct IoTaskPool(pub TaskPool);

A newtype for a task pool for IO-intensive work (i.e. tasks that spend very little time in a “woken” state)

Tuple Fields

0: TaskPool

Methods from Deref<Target = TaskPool>

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, Global> where
    F: 'scope + FnOnce(&mut Scope<'scope, T>) + Send,
    T: 'static + Send, 

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
) -> Task<T> where
    T: 'static + Send, 

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.

If the provided future is non-Send, TaskPool::spawn_local should be used instead.

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

Spawns a static future on the thread-local async executor for the current thread. The task will run entirely on the thread the task was spawned on. 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. Users should generally prefer to use TaskPool::spawn instead, unless the provided future is not Send.

Trait Implementations

impl Clone for IoTaskPool

fn clone(&self) -> IoTaskPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IoTaskPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for IoTaskPool

type Target = TaskPool

The resulting type after dereferencing.

fn deref(&self) -> &<IoTaskPool as Deref>::Target

Dereferences the value.