asynx 0.1.0

Library that helps you to simulate exception without `panic` in async 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
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

//! The exception context that can be use as a `static` variable based on thread-local.

extern crate std;

use std::thread::LocalKey;

/// `ExceptionContext` provides the context for throwing and catching exception.
///
/// This context wraps over a thread-local [crate::unsync::ExceptionContext],
/// and you can store it as a static variable, so that you don't need to pass the
/// context through argument.
///
/// Example:
/// ```
/// use asynx::global::ExceptionContext;
///
/// thread_local! {static EXCEPTION_LOCAL: asynx::unsync::ExceptionContext<String> = Default::default(); }
/// pub static CTX: ExceptionContext<String> = ExceptionContext::new(&EXCEPTION_LOCAL);
///
/// async fn perform(success: bool) -> String {
///     if success {
///         "success".to_string()
///     } else {
///         CTX.throw("failed".to_string()).await
///     }
/// }
///
/// tokio_test::block_on(async {
///     let r = CTX
///         .catch(async {
///             assert_eq!("success".to_string(), perform(true).await);
///             perform(false).await;
///             unreachable!() // The previous statement throws an exception.
///         })
///         .await;
///     assert_eq!(Err("failed".to_string()), r)
/// });
/// ```
pub struct ExceptionContext<E: 'static> {
    inner: &'static LocalKey<crate::unsync::ExceptionContext<E>>,
}

impl<E: 'static> ExceptionContext<E> {
    /// Create a new exception context from a thread-local unsync context.
    pub const fn new(
        local: &'static LocalKey<crate::unsync::ExceptionContext<E>>,
    ) -> ExceptionContext<E> {
        Self { inner: local }
    }

    /// Throws an exception. You should always `await` the result.
    ///
    /// Example:
    ///
    /// ```rust
    /// use asynx::global::ExceptionContext;
    ///
    /// thread_local! {static EXCEPTION_LOCAL: asynx::unsync::ExceptionContext<String> = Default::default(); }
    /// static CTX: ExceptionContext<String> = ExceptionContext::new(&EXCEPTION_LOCAL);
    ///
    /// tokio_test::block_on(async {
    ///     let r = CTX.catch(async {
    ///         CTX.throw("failed".to_string()).await;
    ///         unreachable!()
    ///     }).await;
    ///     assert_eq!(Err("failed".to_string()), r)
    /// })
    /// ```
    pub async fn throw(&self, e: E) -> ! {
        self.inner.with(|ctx| {
            crate::unsync::set_exception(ctx, e);
        });
        core::future::pending().await
    }

    /// Creates the wrapper future that catches the exception.
    ///
    /// Example:
    ///
    /// ```
    /// use asynx::global::ExceptionContext;
    ///
    /// thread_local! {static EXCEPTION_LOCAL: asynx::unsync::ExceptionContext<String> = Default::default(); }
    /// static CTX: ExceptionContext<String> = ExceptionContext::new(&EXCEPTION_LOCAL);
    ///
    /// tokio_test::block_on(async {
    ///     let r = CTX.catch(async {
    ///         "success".to_string()
    ///     }).await;
    ///     assert_eq!(Ok("success".to_string()), r);
    ///
    ///     let r = CTX.catch(async {
    ///         CTX.throw("failed".to_string()).await;
    ///         unreachable!()
    ///     }).await;
    ///     assert_eq!(Err("failed".to_string()), r)
    /// })
    /// ```
    ///
    /// Like the unsync version, the `catch` can be called multiple times.
    ///
    /// ```
    /// use asynx::global::ExceptionContext;
    ///
    /// thread_local! {static EXCEPTION_LOCAL: asynx::unsync::ExceptionContext<i32> = Default::default(); }
    /// static CTX: ExceptionContext<i32> = ExceptionContext::new(&EXCEPTION_LOCAL);
    ///
    /// tokio_test::block_on(async {
    ///     let r = CTX.catch(async {
    ///         let r = CTX.catch(async {
    ///             CTX.throw(1).await
    ///         }).await;
    ///         assert_eq!(Err(1), r);
    ///             
    ///         let r = CTX.catch(async {
    ///             CTX.throw(2).await
    ///         }).await;
    ///         assert_eq!(Err(2), r);
    ///
    ///         CTX.throw(3).await;
    ///     }).await;
    ///     assert_eq!(Err(3), r)
    /// })
    /// ```
    pub fn catch<Fu: core::future::Future>(&self, f: Fu) -> Catching<E, Fu> {
        Catching {
            ctx: self.inner,
            future: f,
        }
    }
}

pin_project_lite::pin_project! {
    /// A wrapper future that catches the exception for thread-local context.
    ///
    /// It outputs a result with the exception as error.
    pub struct Catching<E: 'static, F> {
        ctx: &'static LocalKey<crate::unsync::ExceptionContext<E>>,
        #[pin]
        future: F,
    }
}

impl<E: 'static, F: core::future::Future> core::future::Future for Catching<E, F> {
    type Output = Result<F::Output, E>;

    fn poll(
        self: core::pin::Pin<&mut Self>,
        cx: &mut core::task::Context<'_>,
    ) -> core::task::Poll<Self::Output> {
        let this = self.project();
        this.ctx
            .with(|ctx| crate::unsync::poll_catching(ctx, this.future, cx))
    }
}