lockpool 3.0.1

This library offers a pool of locks where individual locks can be locked/unlocked by key
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

use owning_ref_lockable::OwningHandle;
use std::fmt::{self, Debug};
use std::hash::Hash;
use std::ops::Deref;
use std::sync::Arc;

use super::mutex::MutexImpl;
use crate::pool::LockPoolImpl;

/// A RAII implementation of a scoped lock for locks from a [LockPool]. When this instance is dropped (falls out of scope), the lock will be unlocked.
pub trait Guard<K>: Debug
where
    K: Eq + PartialEq + Hash + Clone + Debug,
{
    /// Returns the key locked by this guard
    fn key(&self) -> &K;
}

#[must_use = "if unused the Mutex will immediately unlock"]
pub struct GuardImpl<'a, K, M, P>
where
    K: Eq + PartialEq + Hash + Clone + Debug,
    M: MutexImpl + 'a,
    P: Deref<Target = LockPoolImpl<K, M>>,
{
    pool: P,
    key: K,
    guard: Option<OwningHandle<Arc<M>, M::Guard<'a>>>,
    poisoned: bool,
}

impl<'a, K, M, P> GuardImpl<'a, K, M, P>
where
    K: Eq + PartialEq + Hash + Clone + Debug,
    M: MutexImpl + 'a,
    P: Deref<Target = LockPoolImpl<K, M>>,
{
    pub(super) fn new(
        pool: P,
        key: K,
        guard: OwningHandle<Arc<M>, M::Guard<'a>>,
        poisoned: bool,
    ) -> Self {
        Self {
            pool,
            key,
            guard: Some(guard),
            poisoned,
        }
    }
}

impl<'a, K, M, P> Guard<K> for GuardImpl<'a, K, M, P>
where
    K: Eq + PartialEq + Hash + Clone + Debug,
    M: MutexImpl + 'a,
    P: Deref<Target = LockPoolImpl<K, M>>,
{
    /// TODO Test
    #[inline]
    fn key(&self) -> &K {
        &self.key
    }
}

impl<'a, K, M, P> Drop for GuardImpl<'a, K, M, P>
where
    K: Eq + PartialEq + Hash + Clone + Debug,
    M: MutexImpl + 'a,
    P: Deref<Target = LockPoolImpl<K, M>>,
{
    fn drop(&mut self) {
        let guard = self
            .guard
            .take()
            .expect("The self.guard field must always be set unless this was already destructed");
        self.pool._unlock(&self.key, guard, self.poisoned);
    }
}

impl<'a, K, M, P> Debug for GuardImpl<'a, K, M, P>
where
    K: Eq + PartialEq + Hash + Clone + Debug,
    M: MutexImpl + 'a,
    P: Deref<Target = LockPoolImpl<K, M>>,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "GuardImpl({:?})", self.key)
    }
}