unsend 0.2.1

A thread unsafe runtime for thread unsafe people
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
119
120
121
122

// SPDX-License-Identifier: LGPL-3.0-or-later OR MPL-2.0
// This file is a part of `unsend`.
//
// `unsend` is free software: you can redistribute it and/or modify it under the
// terms of either:
//
// * GNU Lesser General Public License as published by the Free Software Foundation, either
//   version 3 of the License, or (at your option) any later version.
// * Mozilla Public License as published by the Mozilla Foundation, version 2.
// * The Patron License (https://github.com/notgull/unsend/blob/main/LICENSE-PATRON.md)
//   for sponsors and contributors, who can ignore the copyleft provisions of the above licenses
//   for this project.
//
// `unsend` is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
// PURPOSE. See the GNU Lesser General Public License or the Mozilla Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License and the Mozilla
// Public License along with `unsend`. If not, see <https://www.gnu.org/licenses/>.

//! An asynchronous mutex.

use crate::{Event, EventListener};

use core::cell::{RefCell, RefMut};
use core::ops;
use core::pin::Pin;

/// An asynchronous mutex.
pub struct Mutex<T: ?Sized> {
    /// The event for waiting on the mutex.
    unlocked: Event<()>,

    /// The underlying data.
    data: RefCell<T>,
}

impl<T: Default> Default for Mutex<T> {
    fn default() -> Mutex<T> {
        Mutex::new(Default::default())
    }
}

/// A guard that unlocks the mutex when dropped.
pub struct MutexGuard<'a, T: ?Sized> {
    /// The event to signal.
    event: &'a Event<()>,

    /// The underlying data.
    data: RefMut<'a, T>,
}

impl<T> Mutex<T> {
    /// Creates a new asynchronous mutex.
    pub fn new(data: T) -> Mutex<T> {
        Mutex {
            unlocked: Event::new(),
            data: RefCell::new(data),
        }
    }

    /// Unwraps the underlying data.
    pub fn into_inner(self) -> T {
        self.data.into_inner()
    }
}

impl<T: ?Sized> Mutex<T> {
    /// Get a mutable reference to the underlying data.
    pub fn get_mut(&mut self) -> &mut T {
        self.data.get_mut()
    }

    /// Try to lock the mutex.
    pub fn try_lock(&self) -> Option<MutexGuard<'_, T>> {
        self.data.try_borrow_mut().ok().map(|data| MutexGuard {
            event: &self.unlocked,
            data,
        })
    }

    /// Lock the mutex.
    pub async fn lock(&self) -> MutexGuard<'_, T> {
        // TODO: Use a fairer locking algorithm.
        let mut listener = EventListener::new(&self.unlocked);

        {
            let mut listener = unsafe { Pin::new_unchecked(&mut listener) };

            loop {
                // Try to lock the mutex.
                if let Some(lock) = self.try_lock() {
                    return lock;
                }

                // Wait for the mutex to be unlocked.
                listener.as_mut().await;
            }
        }
    }
}

impl<T: ?Sized> ops::Deref for MutexGuard<'_, T> {
    type Target = T;

    fn deref(&self) -> &T {
        &self.data
    }
}

impl<T: ?Sized> ops::DerefMut for MutexGuard<'_, T> {
    fn deref_mut(&mut self) -> &mut T {
        &mut self.data
    }
}

impl<T: ?Sized> Drop for MutexGuard<'_, T> {
    fn drop(&mut self) {
        self.event.notify(1);
    }
}