Struct TaskStream 

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

A Bevy SystemParam to execute async streams in the background.

Implementations

impl<T> TaskStream<'_, T>

where T: ConditionalSend + 'static,

pub fn is_idle(&self) -> bool

Returns whether the stream is idle (not started).

pub fn is_pending(&self) -> bool

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

pub fn is_finished(&self) -> bool

Returns whether the stream is finished.

pub fn start(&mut self, stream: impl Into<AsyncStream<T>>)

Start an async stream in the background. If there is an existing stream pending, it will be dropped and replaced with the given stream.

pub fn forget(&mut self)

Forget the stream being run. This does not stop the stream.

Note: Bevy does not support cancelling a task on web currently.

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

Poll for the next item. Returns Poll::Ready(Some(T)) if an item is available, Poll::Ready(None) if the stream is finished, or Poll::Pending if waiting.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

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

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

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

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

type Item<'w, 's> = TaskStream<'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) -> Self::State

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.

fn init_access( _state: &Self::State, _system_meta: &mut SystemMeta, _component_access_set: &mut FilteredAccessSet, _world: &mut World, )

Registers any World access used by this SystemParam

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: &mut 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 TaskStream<'_, T>