async-backtrace 0.2.0

Efficient, logical 'backtraces' of async tasks.
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

use core::future::Future;
use core::pin::Pin;
use core::task::{Context, Poll};
use std::marker::PhantomPinned;

use crate::frame::Frame;
use crate::location::Location;

use pin_project_lite::pin_project;

pin_project! {
    /// A future whose [`Location`] is included in [taskdumps][crate::tasks] and [backtraces][crate::backtrace].
    pub struct Framed<F> {
        // The wrapped future.
        #[pin]
        future: F,
        // Metadata about the wrapped future.
        #[pin]
        frame: Frame,
        _pinned: PhantomPinned,
    }
}

impl<F: core::panic::UnwindSafe> core::panic::UnwindSafe for Framed<F> {}

impl<F> Framed<F> {
    /// Include the given `future` in taskdumps and
    /// backtraces with the given `location`.
    pub fn new(future: F, location: Location) -> Self {
        Self {
            future,
            frame: Frame::new(location),
            _pinned: PhantomPinned,
        }
    }
}

impl<F> Future for Framed<F>
where
    F: Future,
{
    type Output = <F as Future>::Output;

    #[track_caller]
    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<<Self as Future>::Output> {
        let this = self.project();
        let frame = this.frame;
        let future = this.future;
        frame.in_scope(|| future.poll(cx))
    }
}