Struct bevy_tasks::Scope

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

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

For more information, see TaskPool::scope.

Implementations§

source§

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

source

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

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

On the single threaded task pool, it just calls Scope::spawn_on_scope.

For more information, see TaskPool::scope.

source

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

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

On the single threaded task pool, it just calls Scope::spawn_on_scope.

For more information, see TaskPool::scope.

source

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

Spawns a scoped future that runs on the thread the scope called from. 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 more information, see TaskPool::scope.

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'scope, 'env, T> Freeze for Scope<'scope, 'env, T>

§

impl<'scope, 'env, T> !RefUnwindSafe for Scope<'scope, 'env, T>

§

impl<'scope, 'env, T> !Send for Scope<'scope, 'env, T>

§

impl<'scope, 'env, T> !Sync for Scope<'scope, 'env, T>

§

impl<'scope, 'env, T> Unpin for Scope<'scope, 'env, T>

§

impl<'scope, 'env, T> !UnwindSafe for Scope<'scope, 'env, T>

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.