pub struct AsyncEventWriter<'a, T: Send + 'static> { /* private fields */ }Expand description
System parameter for spawning async work whose result is delivered as a
T event once it resolves. The friendly front door for combining
BackgroundTasks::spawn_async with the Events system, instead of
hand-rolling a pending-task resource and poll system per async data
source the way GraphicsPlugin
does for the GPU backend.
Register the event type with App::add_async_event::<T>()
(instead of App::add_event) to make this usable as a system
parameter. Reading the result is completely ordinary — just an
EventReader<T>, same as any other event; nothing about consuming it
differs from a synchronously-sent one. Requires
BackgroundTasksPlugin to be
registered, since spawn drives its future through
BackgroundTasks::spawn_async.
app.add_async_event::<ReadbackDone>();
fn start_readback(events: AsyncEventWriter<ReadbackDone>, backend: Res<WGPUBackend>) {
let future = backend.readback_buffer(&buf);
events.spawn(async move { ReadbackDone(future.await) });
}
fn on_readback(mut reader: EventReader<ReadbackDone>) {
for event in reader.iter() {
// event.0
}
}Implementations§
Source§impl<'a, T: Send + 'static> AsyncEventWriter<'a, T>
impl<'a, T: Send + 'static> AsyncEventWriter<'a, T>
Sourcepub fn spawn(&self, future: impl SpawnableFuture<T>)
pub fn spawn(&self, future: impl SpawnableFuture<T>)
Spawn future. Once it resolves, its output is delivered to every
EventReader<T> — no matter how many ticks the future takes, and
with no need to hold onto a handle or poll anything yourself.
Trait Implementations§
Source§impl<T> SystemParam for AsyncEventWriter<'static, T>
impl<T> SystemParam for AsyncEventWriter<'static, T>
type Item<'a> = AsyncEventWriter<'a, T>
type State = ()
fn fetch<'a>( _state: &'a mut Self::State, world: &'a World, resources: &'a Resources, ) -> Self::Item<'a>
Source§fn requires() -> Vec<RequiredResource>
fn requires() -> Vec<RequiredResource>
App to validate — before
running a non-convergent stage’s systems — that every hard
requirement is already satisfied, failing fast with a clear message
instead of panicking deep inside whichever system happens to run
first. Read moreAuto Trait Implementations§
impl<'a, T> Freeze for AsyncEventWriter<'a, T>
impl<'a, T> RefUnwindSafe for AsyncEventWriter<'a, T>
impl<'a, T> Send for AsyncEventWriter<'a, T>
impl<'a, T> Sync for AsyncEventWriter<'a, T>
impl<'a, T> Unpin for AsyncEventWriter<'a, T>
impl<'a, T> UnsafeUnpin for AsyncEventWriter<'a, T>
impl<'a, T> UnwindSafe for AsyncEventWriter<'a, T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> Component for T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more