lock_ordering 0.2.0

Lock ordering enforcement at compile time.
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

//! Traits that describe how locked data is accessed.

pub use mutex::MutexLock;
pub use rwlock::RwLock;
#[cfg(feature = "async")]
pub use {mutex::AsyncMutexLock, rwlock::AsyncRwLock};

use crate::{LockLevel, MutualExclusion, ReadWrite};

mod mutex;
mod rwlock;

/// Connects a [`LockLevel`] with a [`MutexLock`] implementation.
pub trait MutexLockLevel: LockLevel<Method = MutualExclusion> {
    type Mutex: MutexLock;
}

/// Connects a [`LockLevel`] with a [`RwLock`] implementation.
pub trait RwLockLevel: LockLevel<Method = ReadWrite> {
    type RwLock: RwLock;
}

/// Connects a [`LockLevel`] with a [`MutexLock`] implementation.
#[cfg(feature = "async")]
pub trait AsyncMutexLockLevel: LockLevel<Method = MutualExclusion> {
    type Mutex: AsyncMutexLock;
}

/// Connects a [`LockLevel`] with a [`RwLock`] implementation.
#[cfg(feature = "async")]
pub trait AsyncRwLockLevel: LockLevel<Method = ReadWrite> {
    type RwLock: AsyncRwLock;
}