Struct TaskPool

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

A Bevy SystemParam to execute many similar AsyncTasks in the background simultaneously.

Implementations

impl<T: ConditionalSend + 'static> TaskPool<'_, T>

pub fn is_idle(&self) -> bool

Returns whether the task pool is idle.

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

Spawn an async task in the background.

pub fn iter_poll(&mut self) -> impl Iterator<Item = Poll<T>>

Iterate and poll the task pool for the current task statuses.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

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

type Item<'s> = TaskPool<'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 TaskPool<'_, T>

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

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

type Item<'w, 's> = TaskPool<'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 ApplyDeferred.

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

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

unsafe fn validate_param( state: &Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

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