Struct AsyncTaskRunner

pub struct AsyncTaskRunner<'s, T>(/* private fields */);

A Bevy SystemParam to execute AsyncTasks individually in the background.

Implementations

impl<T> AsyncTaskRunner<'_, T>

pub fn is_idle(&self) -> bool

Returns whether the task runner is idle.

pub fn is_pending(&self) -> bool

Returns whether the task runner is pending (running, but not finished).

pub fn is_finished(&self) -> bool

Returns whether the task runner is finished.

pub fn start(&mut self, task: impl Into<AsyncTask<T>>)

Start an async task in the background. If there is an existing task pending, it will be dropped and replaced with the given task. If you need to run multiple tasks, use the [AsyncTaskPool].

pub fn poll(&mut self) -> Poll<T>

Poll the task runner for the current task status. Possible returns are Pending or Ready(T).

Trait Implementations

impl<'s, T: Debug> Debug for AsyncTaskRunner<'s, T>

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

Formats the value using the given formatter.

impl<T: Send + 'static> ExclusiveSystemParam for AsyncTaskRunner<'_, T>

type State = SyncCell<Option<AsyncReceiver<T>>>

Used to store data which persists across invocations of a system.

type Item<'s> = AsyncTaskRunner<'s, T>

The item type returned when constructing this system param. See SystemParam::Item.

fn init(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State

Creates a new instance of this param’s State.

fn get_param<'s>( state: &'s mut Self::State, _system_meta: &SystemMeta, ) -> Self::Item<'s>

Creates a parameter to be passed into an ExclusiveSystemParamFunction.

impl<T: Send + 'static> SystemParam for AsyncTaskRunner<'_, T>

type State = SyncCell<Option<AsyncReceiver<T>>>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = AsyncTaskRunner<'s, T>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, _change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

unsafe fn validate_param( _state: &Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'_>, ) -> bool

Validates that the param can be acquired by the get_param. Built-in executors use this to prevent systems with invalid params from running. For nested SystemParams validation will fail if any delegated validation fails.

impl<T: Send + 'static> ReadOnlySystemParam for AsyncTaskRunner<'_, T>