bevy_eventwork 0.10.0

Event based networking library for Bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

mod bevy_runtime;

use std::future::Future;

use bevy::prelude::{Deref, DerefMut, Resource};

/// A Resource that provides access to the runtime to internal Eventwork systems.
///
/// This *must* be inserted into the app for the Eventwork plugin to work
#[derive(Resource, DerefMut, Deref)]
pub struct EventworkRuntime<RT: Runtime + Send + Sync>(pub RT);

/// A runtime abstraction allowing you to use any runtime for spicy
pub trait Runtime: Send + Sync + 'static {
    /// Associated handle
    type JoinHandle: JoinHandle;

    /// Create a long running background task that is [`Send`] and [`Sync`].
    fn spawn(&self, task: impl Future<Output = ()> + Send + 'static) -> Self::JoinHandle;

    /// Create a long running background task that is *not* [`Send`] and [`Sync`] and will be run on the main thread
    fn spawn_local(&self, task: impl Future<Output = ()> + 'static) -> Self::JoinHandle;
}

/// A runtime abstraction allowing you to use any runtime with spicy
pub trait JoinHandle: 'static + Send + Sync {
    /// Stop the task.
    fn abort(&mut self);
}

#[cfg(not(target_arch = "wasm32"))]
pub fn run_async<F, RT: Runtime>(future: F, runtime: &RT) -> <RT as Runtime>::JoinHandle
where
    F: Future<Output = ()> + Send + 'static,
{
    runtime.spawn(future)
}

#[cfg(target_arch = "wasm32")]
pub fn run_async<F, RT: Runtime>(future: F, runtime: &RT) -> <RT as Runtime>::JoinHandle
where
    F: Future<Output = ()> + 'static,
{
    runtime.spawn_local(future)
}