usync 0.2.1

fast, drop-in, synchronization primitives
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

#![warn(
    rust_2018_idioms,
    unreachable_pub,
    missing_docs,
    missing_debug_implementations
)]

//! This library provides implementations of `Mutex`, `RwLock`, `Condvar`,
//! `Barrier`, and `Once` that are smaller and faster than those in the Rust
//! standard library. It also provides a `ReentrantMutex` type.
//!
//! Everything is powered by lock-free thread queues in userspace
//! which allows the synchronization primitives to be 1 word (`usize`) large.
//! All thread blocking is done through [`std::thread::park`] for maximum portability.

mod barrier;
mod condvar;
mod mutex;
mod once;
mod reentrant_mutex;
mod rwlock;
mod shared;
mod thread_id;

pub use ::lock_api;

#[cfg(feature = "send_guard")]
type GuardMarker = lock_api::GuardSend;
#[cfg(not(feature = "send_guard"))]
type GuardMarker = lock_api::GuardNoSend;

pub use self::{
    barrier::{Barrier, BarrierWaitResult},
    condvar::{Condvar, WaitTimeoutResult},
    mutex::{const_mutex, MappedMutexGuard, Mutex, MutexGuard, RawMutex},
    once::{Once, OnceState},
    reentrant_mutex::{
        const_reentrant_mutex, MappedReentrantMutexGuard, ReentrantMutex, ReentrantMutexGuard,
    },
    rwlock::{
        const_rwlock, MappedRwLockReadGuard, MappedRwLockWriteGuard, RawRwLock, RwLock,
        RwLockReadGuard, RwLockWriteGuard,
    },
    thread_id::RawThreadId,
};