pasts 0.1.0

Minimal and simpler alternative to the futures crate.
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

// Pasts
//
// Copyright (c) 2019-2020 Jeron Aldaron Lau
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// https://apache.org/licenses/LICENSE-2.0>, or the Zlib License, <LICENSE-ZLIB
// or http://opensource.org/licenses/Zlib>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

#![allow(clippy::mutex_atomic)]

use std::sync::{Condvar, Mutex};

/// **std** feature required.  An efficient thread interrupt.
///
/// If you can use std, use this `Interrupt`.
#[derive(Debug)]
pub struct ThreadInterrupt(Mutex<usize>, Condvar);

impl crate::Interrupt for ThreadInterrupt {
    // Initialize the shared data for the interrupt.
    fn new() -> Self {
        ThreadInterrupt(Mutex::new(0), Condvar::new())
    }

    // Interrupt blocking to wake up.
    fn interrupt(&self) {
        // Add 1 to the number of interrupts.
        let mut num = self.0.lock().unwrap();
        *num += 1;

        // We notify the condvar that the value has changed.
        self.1.notify_one();
    }

    // Blocking wait for interrupt, if `Poll::Ready` then stop blocking.
    fn wait_for(&self) {
        // Lock the mutex.
        let mut guard = self.0.lock().unwrap();

        // Reduce by 1 if non-zero.
        if *guard != 0 {
            *guard -= 1;
            if *guard != 0 {
                // After subtraction, still a task waiting - so don't wait.
                return;
            }
        }

        // Wait until not zero (unlock mutex).
        let _guard = self.1.wait(guard).unwrap();
    }
}