bp3d_debug/trace/
future.rs

1// Copyright (c) 2024, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use crate::trace::span::{Entered, Span};
30use crate::trace::Trace;
31use std::future::Future;
32use std::pin::Pin;
33use std::task::{Context, Poll};
34
35pub struct TracedFuture<F> {
36    future: F,
37    span: Option<Entered>,
38}
39
40impl<F: Future> Future for TracedFuture<F> {
41    type Output = F::Output;
42
43    fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
44        unsafe {
45            let pin = Pin::new_unchecked(&mut self.future);
46            let value = pin.poll(cx);
47            if value.is_ready() {
48                drop(self.span.take());
49            }
50            value
51        }
52    }
53}
54
55impl<F> Unpin for TracedFuture<F> {}
56
57impl<F: Future> Trace for F {
58    type Output = TracedFuture<F>;
59
60    fn trace(self, span: Span) -> Self::Output {
61        TracedFuture {
62            future: self,
63            span: Some(span.enter()),
64        }
65    }
66}
bp3d_debug/trace/future.rs

bp3d_debug/trace/
future.rs
