concurrency_toolkit 0.2.8

Easy switching between std::sync, tokio::sync and loom::sync
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
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

#[cfg(not(features = "permutation_testing"))]
mod state_storage {
    pub use std::sync::Arc;
}
#[cfg(features = "permutation_testing")]
mod state_storage {
    pub use loom::sync::Arc;
}
pub use state_storage::*;

#[cfg(feature = "default")]
mod state_sync {
    pub use std::sync::{RwLock, RwLockReadGuard, RwLockWriteGuard, LockResult, TryLockResult};

    #[inline(always)]
    pub fn obtain_read_lock<T>(rwlock: &RwLock<T>)
        -> LockResult<RwLockReadGuard<'_, T>>
    {
        rwlock.read()
    }

    #[inline(always)]
    pub fn obtain_write_lock<T>(rwlock: &RwLock<T>)
        -> LockResult<RwLockWriteGuard<'_, T>>
    {
        rwlock.write()
    }

    /// Must use [`maybe_async`](/maybe_async) keyword when using this macro
    #[macro_export]
    macro_rules! obtain_read_lock {
        ( $lock:expr ) => {
            $crate::sync::obtain_read_lock($lock)
        };
    }

    /// Must use [`maybe_async`](/maybe_async) keyword when using this macro
    #[macro_export]
    macro_rules! obtain_write_lock {
        ( $lock:expr ) => {
            $crate::sync::obtain_write_lock($lock)
        };
    }
}

#[cfg(feature = "async_tokio")]
mod state_sync {
    pub use tokio::sync::{RwLock, RwLockReadGuard, RwLockWriteGuard};
    pub type LockResult<T> = Result<T, ()>;
    pub type TryLockResult<T> = Result<T, tokio::sync::TryLockError>;

    #[inline(always)]
    pub async fn obtain_read_lock<T>(rwlock: &RwLock<T>)
        -> LockResult<RwLockReadGuard<'_, T>>
    {
        Ok(rwlock.read().await)
    }

    #[inline(always)]
    pub async fn obtain_write_lock<T>(rwlock: &RwLock<T>)
        -> LockResult<RwLockWriteGuard<'_, T>>
    {
        Ok(rwlock.write().await)
    }

    /// Must use [`maybe_async`](/maybe_async) keyword when using this macro
    #[macro_export]
    macro_rules! obtain_read_lock {
        ( $lock:expr ) => {
            $crate::sync::obtain_read_lock($lock).await
        };
    }

    /// Must use [`maybe_async`](/maybe_async) keyword when using this macro
    #[macro_export]
    macro_rules! obtain_write_lock {
        ( $lock:expr ) => {
            $crate::sync::obtain_write_lock($lock).await
        };
    }
}

#[cfg(feature = "permutation_testing")]
mod state_sync {
    pub use loom::sync::{RwLock, RwLockReadGuard, RwLockWriteGuard, LockResult, TryLockResult};

    #[inline(always)]
    pub fn obtain_read_lock<T>(rwlock: &RwLock<T>)
        -> LockResult<RwLockReadGuard<'_, T>>
    {
        rwlock.read()
    }

    #[inline(always)]
    pub fn obtain_write_lock<T>(rwlock: &RwLock<T>)
        -> LockResult<RwLockWriteGuard<'_, T>>
    {
        rwlock.write()
    }

    /// Must use [`maybe_async`](/maybe_async) keyword when using this macro
    #[macro_export]
    macro_rules! obtain_read_lock {
        ( $lock:expr ) => {
            $crate::sync::obtain_read_lock($lock)
        };
    }

    /// Must use [`maybe_async`](/maybe_async) keyword when using this macro
    #[macro_export]
    macro_rules! obtain_write_lock {
        ( $lock:expr ) => {
            $crate::sync::obtain_write_lock($lock)
        };
    }
}

pub use state_sync::*;