os-trait 0.11.0

Traits used to adapter different embedded RTOS.
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

use crate::{Duration, OsInterface, Timeout};

/// This method should be able to call from task or ISR.
/// The implementation should handle the different situations.
pub trait NotifierInterface: Send + Clone {
    fn notify(&self) -> bool;
}

pub trait NotifyWaiterInterface<OS: OsInterface>: Send {
    /// Wait until notified or timeout occurs.
    /// # Returns
    ///   - `true` notified
    ///   - `false` timeout occurred
    fn wait(&self, timeout: &Duration<OS>) -> bool;

    /// # Description
    /// Wait for a notification, and call your function to check anything you want
    /// when receiving a notification. You can control whether or not to continue
    /// waiting for the next notification.
    ///
    /// # Parameters
    /// - `timeout`: Total timeout.
    /// - `f`: Your function. If it returns `Some(x)`, it will break out of the wait.
    ///
    /// # Returns
    /// - `None`: It's timeout.
    /// - `Some(x)`: The value returned by your function.
    #[inline]
    fn wait_with<U>(&self, timeout: &Duration<OS>, mut f: impl FnMut() -> Option<U>) -> Option<U> {
        let mut wait_time = timeout.clone();
        let mut t = Timeout::<OS>::from(timeout);
        loop {
            if let Some(rst) = f() {
                return Some(rst);
            }
            if t.timeout() {
                return None;
            }

            let left_time = t.time_left();
            if left_time < wait_time {
                wait_time = left_time;
            }
            self.wait(&wait_time);
        }
    }
}