bevy_async_task 0.12.0

Ergonomic abstractions to async programming in 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
46
47
48
49

//! Ergonomic abstractions to async programming in Bevy for all platforms.

mod error;
mod receiver;
mod stream;
mod task;
mod task_pool;
mod task_runner;
mod task_stream;
mod util;

pub use error::TimeoutError;
pub use receiver::AsyncReceiver;
pub use receiver::AsyncStreamReceiver;
pub use stream::AsyncStream;
pub use task::AsyncTask;
pub use task::TimedAsyncTask;
pub use task_pool::TaskPool;
pub use task_pool::TimedTaskPool;
pub use task_runner::TaskRunner;
pub use task_runner::TimedTaskRunner;
pub use task_stream::TaskStream;
pub use util::pending;
pub use util::sleep;
pub use util::timeout;

/// A good default timeout. Values over `i32::MAX` will cause panics on web.
pub const DEFAULT_TIMEOUT: core::time::Duration = core::time::Duration::from_millis(60 * 1000);

/// The maximum timeout allowed. Anything above this will cause a panic on web.
pub const MAX_TIMEOUT: core::time::Duration = {
    // See: https://stackoverflow.com/questions/3468607/why-does-settimeout-break-for-large-millisecond-delay-values
    static I32_MAX_U64: u64 = 2_147_483_647;
    core::time::Duration::from_millis(I32_MAX_U64)
};

#[doc(hidden)]
pub mod polyfill {
    use bevy_tasks::ConditionalSend;
    use bevy_tasks::futures_lite::Stream;

    /// The missing conditional send stream trait.
    /// see: <https://github.com/bevyengine/bevy/issues/22093>
    pub trait ConditionalSendStream: Stream + ConditionalSend {}

    impl<T: Stream + ConditionalSend> ConditionalSendStream for T {}
}

pub use polyfill::ConditionalSendStream;