Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement FusedFuture for framed futures #42

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions backtrace/src/framed.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use core::future::Future;
use core::pin::Pin;
use core::task::{Context, Poll};
use futures::future::FusedFuture;
use std::marker::PhantomPinned;

use crate::frame::Frame;
Expand Down Expand Up @@ -49,3 +50,9 @@ where
frame.in_scope(|| future.poll(cx))
}
}

impl<F: FusedFuture> FusedFuture for Framed<F> {
fn is_terminated(&self) -> bool {
self.future.is_terminated()
}
}
2 changes: 1 addition & 1 deletion backtrace/src/location.rs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ impl Location {
/// }).await
/// }
/// ```
pub fn frame<F>(self, f: F) -> impl Future<Output = F::Output>
pub fn frame<F>(self, f: F) -> crate::Framed<F>
where
F: Future,
{
Expand Down
26 changes: 26 additions & 0 deletions backtrace/tests/fused.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
use futures::{future::FusedFuture, FutureExt};

/// A test that frame can propagate FusedFuture.
mod util;

#[test]
fn consolidate() {
util::model(|| util::run(fused_future()));
}

#[async_backtrace::framed]
fn fused_future() -> impl FusedFuture<Output = ()> {
async_backtrace::location!().frame(ready().fuse())
}

#[async_backtrace::framed]
async fn ready() {
let dump = async_backtrace::taskdump_tree(true);

pretty_assertions::assert_str_eq!(
util::strip(dump),
"\
╼ fused::fused_future at backtrace/tests/fused.rs:LINE:COL
└╼ fused::ready::{{closure}} at backtrace/tests/fused.rs:LINE:COL"
);
}