Struct bevy_tasks::Scope

pub struct Scope<'scope, 'env: 'scope, T> { /* private fields */ }

A TaskPool scope for running one or more non-'static futures.

For more information, see TaskPool::scope.

Implementations

impl<'scope, 'env, T: Send + 'scope> Scope<'scope, 'env, T>

pub fn spawn<Fut: Future<Output = T> + 'scope + Send>(&self, f: Fut)

Spawns a scoped future onto the thread pool. The scope must outlive the provided future. The results of the future will be returned as a part of TaskPool::scope’s return value.

For futures that should run on the thread scope is called on Scope::spawn_on_scope should be used instead.

For more information, see TaskPool::scope.

pub fn spawn_on_scope<Fut: Future<Output = T> + 'scope + Send>(&self, f: Fut)

Spawns a scoped future onto the thread the scope is run on. The scope must outlive the provided future. The results of the future will be returned as a part of TaskPool::scope’s return value. Users should generally prefer to use Scope::spawn instead, unless the provided future needs to run on the scope’s thread.

For more information, see TaskPool::scope.

pub fn spawn_on_external<Fut: Future<Output = T> + 'scope + Send>(&self, f: Fut)

Spawns a scoped future onto the thread of the external thread executor. This is typically the main thread. The scope must outlive the provided future. The results of the future will be returned as a part of TaskPool::scope’s return value. Users should generally prefer to use Scope::spawn instead, unless the provided future needs to run on the external thread.

For more information, see TaskPool::scope.

Trait Implementations

impl<'scope, 'env: 'scope, T: Debug> Debug for Scope<'scope, 'env, T>

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

Formats the value using the given formatter.

impl<'scope, 'env, T> Drop for Scope<'scope, 'env, T>where T: 'scope,

fn drop(&mut self)

Executes the destructor for this type.