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

use super::{maybe_unwind, UnwindContext};
use futures_core::{
    future::Future,
    task::{self, Poll},
};
use pin_project::pin_project;
use std::{
    panic::{AssertUnwindSafe, UnwindSafe},
    pin::Pin,
};

/// A future for the [`maybe_unwind`] method.
///
/// [`maybe_unwind`]: ./trait.FutureMaybeUnwindExt.html#method.maybe_unwind
#[pin_project]
#[derive(Debug)]
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct MaybeUnwind<T> {
    #[pin]
    inner: T,
}

impl<F> Future for MaybeUnwind<F>
where
    F: Future + UnwindSafe,
{
    type Output = Result<F::Output, UnwindContext>;

    fn poll(self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> Poll<Self::Output> {
        let me = self.project();
        maybe_unwind(AssertUnwindSafe(|| me.inner.poll(cx)))?.map(Ok)
    }
}

/// An extension trait for `Future`s that provides an adaptor for capturing
/// the unwinding panic information.
pub trait FutureMaybeUnwindExt: Future + Sized {
    /// Catches unwinding panics while polling the future.
    ///
    /// This is a variant of [`catch_unwind`] that also captures
    /// the panic information.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use maybe_unwind::maybe_unwind;
    /// use maybe_unwind::FutureMaybeUnwindExt as _;
    ///
    /// maybe_unwind::set_hook();
    ///
    /// # futures_executor::block_on(async {
    /// let res: Result<_, maybe_unwind::UnwindContext> = do_something_async()
    ///     .maybe_unwind()
    ///     .await;
    /// # });
    ///
    /// maybe_unwind::reset_hook();
    /// # async fn do_something_async() {}
    /// ```
    ///
    /// [`catch_unwind`]: https://docs.rs/futures/0.3/futures/future/trait.FutureExt.html#method.catch_unwind
    fn maybe_unwind(self) -> MaybeUnwind<Self>
    where
        Self: UnwindSafe,
    {
        MaybeUnwind { inner: self }
    }
}

impl<F: Future> FutureMaybeUnwindExt for F {}