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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! TODO:
//! - Re-factor builder implementation.
//! - Add `MessageSend` macro.
//! - Add `WorkletBuilder` (or use `Builder`).
//! - Wrap `MessageChannel` into something safe.
//! - Consider passing message into `Builder`.
//! - Add README.
//! - Consider moving some APIs into `web-thread-core/primitives`.
//!
//! Things to note:
//! - Will fail on import when used with the `no-modules` target.
//! - Blocking is not recommended, e.g. blocks events.
//! - Audio worklets are very limited, e.g. should not do any allocation.
//! - Spawning happens on the "main" thread, e.g. if blocked nothing will spawn
//!   (affects some browsers only).
//! - Calling any functions from a thread not spawned by `web-thread` will cause
//!   issues.
//!
//! Browser bugs:
//! - Browsers don't support `TextEncoder`/`TextDecoder` in audio worklets:
//!   - Chrome: ?
//!   - Firefox: <https://bugzilla.mozilla.org/show_bug.cgi?id=1826432>
//!   - Safari: ?
//! - Firefox doesn't support module service workers: <https://bugzilla.mozilla.org/show_bug.cgi?id=1360870>.
//! - Browsers don't support blocking in shared workers:
//!   - Firefox: <https://bugzilla.mozilla.org/show_bug.cgi?id=1359745>
//!   - Safari: ?
//! - Spec doesn't allow cross-origin isolation in shared and service workers: <https://github.com/w3c/ServiceWorker/pull/1545>.
//! - Browsers don't support spawning and blocking afterwards (e.g.
//!   `spawn(..).join()`):
//!   - Chrome:
//!     - Spawning: <https://issues.chromium.org/issues/40633395>
//!     - `postMessage()`: <https://issues.chromium.org/issues/40687798>
//!   - Safari: ?
//! - Browsers don't properly shutdown audio worklet when state is `closed`:
//!   - Chrome: <https://issues.chromium.org/issues/40072701>
//!   - Firefox: <https://bugzilla.mozilla.org/show_bug.cgi?id=1878516>
//!   - Safari: ?
//! - Headless browsers seem to have some issues when spawning too many threads:
//!   - Firefox: ?
//!   - Safari: ?
//! - Headless Firefox can't run `AudioContext` without a real audio device: <https://bugzilla.mozilla.org/show_bug.cgi?id=1881904>.
//! - Chrome fails to send `WebAssembly.Module` over `AudioWorkletNode.port`: <https://issues.chromium.org/issues/40855462>.

#![doc(test(attr(deny(unused, warnings))))]
#![cfg_attr(
	all(
		target_family = "wasm",
		target_os = "unknown",
		target_feature = "atomics"
	),
	feature(stdarch_wasm_atomic_wait)
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg, doc_cfg_hide))]
#![cfg_attr(
	docsrs,
	doc(cfg_hide(docsrs, target_family = "wasm", target_os = "unknown"))
)]

#[cfg(all(target_family = "wasm", target_os = "unknown"))]
mod thread;
#[cfg(any(all(target_family = "wasm", target_os = "unknown"), docsrs))]
#[cfg_attr(docsrs, doc(cfg(Web)))]
pub mod web;

pub use std::thread::*;

#[cfg(all(target_family = "wasm", target_os = "unknown"))]
#[allow(deprecated)]
pub use self::thread::{
	available_parallelism, current, park, park_timeout, park_timeout_ms, scope, sleep, sleep_ms,
	spawn, yield_now, Builder, JoinHandle, Scope, ScopedJoinHandle, Thread, ThreadId,
};

#[cfg(all(
	target_family = "wasm",
	target_os = "unknown",
	target_feature = "exception-handling"
))]
compile_error!("this library does not work correctly with the exception handling proposal");