Crate wasm_sync

source ·
Expand description

wasm_sync offers synchronization primitives that work in both browser and native contexts.

In web browsers, use of atomic wait instructions on the main thread causes an error. This prevents the use of standard library synchronization primitives within web contexts. wasm_sync solves this problem by busy-spinning on the main thread. Other threads, like dedicated web workers, still use atomic wait instructions.

On native platforms, wasm_sync simply re-exports the standard library’s synchronization primitives.

Supported primitives

Usage

Instead of importing a standard library primitive, import the wasm_sync variant. For example:

use std::sync::Arc;
use std::thread;
use wasm_sync::Mutex;
 
let mutex = Arc::new(Mutex::new(0));
let c_mutex = Arc::clone(&mutex);
 
thread::spawn(move || {
    *c_mutex.lock().unwrap() = 10;
}).join().expect("thread::spawn failed");
assert_eq!(*mutex.lock().unwrap(), 10);

Structs

  • Condvar
    A Condition Variable
  • Mutex
    A mutual exclusion primitive useful for protecting shared data
  • Once
    A synchronization primitive which can be used to run a one-time global initialization. Useful for one-time initialization for FFI or related functionality. This type can only be constructed with Once::new().
  • OnceLock
    A synchronization primitive which can be written to only once.
  • RwLock
    A reader-writer lock

Constants