traffic-light 0.1.0

Another single-threaded block asynchronous executor for Rust
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

//! Extension trait for [`Future`].
//!
//! # Examples
//!
//! ```
//! use traffic_light::future::FutureExt as _;
//!
//! fn main() -> std::result::Result<(), Box<dyn std::error::Error>> {
//!     async {
//!         // ...
//!         Ok::<(), Box<dyn std::error::Error>>(())
//!     }.block_on()?;
//!
//!     Ok(())
//! }
//! ```

use crate::executor::Executor;

/// An extension trait for [`Future`] that provides blocking.
pub trait FutureExt: Future {
    /// Blocks the current thread on this future.
    ///
    /// # Panics
    ///
    /// Panics if this future panics.
    ///
    /// # Examples
    ///
    /// ```
    /// use traffic_light::future::FutureExt as _;
    ///
    /// let x: std::result::Result<(), Box<dyn std::error::Error>> =
    ///     async {
    ///         // ...
    ///         Ok(())
    ///     }.block_on();
    ///
    /// assert!(x.is_ok());
    /// ```
    fn block_on(self) -> Self::Output;
}

impl<F: Future> FutureExt for F {
    fn block_on(self) -> Self::Output {
        Executor::block_on(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn block_on_result_ok() {
        let x: std::result::Result<(), Box<dyn std::error::Error>> =
            async {
                Ok(())
            }.block_on();

        assert!(x.is_ok());
    }

    #[test]
    fn block_on_result_err() {
        let x: std::result::Result<(), &str> =
            async {
                Err("")
            }.block_on();

        assert!(x.is_err());
    }
}