Struct TracedFuture 

pub struct TracedFuture<F> { /* private fields */ }

A future wrapper that records each poll as a PollEvent.

Use TracedFuture::run for a convenient way to execute a future and collect its trace.

If the wrapped future is dropped before it completes, a final event with PollResult::Cancelled is appended to the trace.

Examples

use async_reify::TracedFuture;

let (val, trace) = TracedFuture::run(async { 1 + 1 }).await;
assert_eq!(val, 2);
assert!(!trace.events.is_empty());

Implementations

impl<F> TracedFuture<F>

where F: Future,

pub fn new(inner: F) -> TracedFuture<F>

Create a new traced future wrapping inner.

Examples

use async_reify::TracedFuture;

let traced = TracedFuture::new(async { 42 });

pub fn with_label(inner: F, label: &str) -> TracedFuture<F>

Create a new traced future with a label.

Examples

use async_reify::TracedFuture;

let traced = TracedFuture::with_label(async { 42 }, "my_step");

pub async fn run(inner: F) -> (<F as Future>::Output, Trace)

Run the future to completion, returning the result and the trace.

This is a convenience wrapper that polls the future through a TracedFuture and collects all events.

Examples

use async_reify::{TracedFuture, PollResult};

let (result, trace) = TracedFuture::run(async { "hello" }).await;
assert_eq!(result, "hello");
assert!(matches!(trace.events.last().unwrap().result, PollResult::Ready));

Trait Implementations

impl<F> Drop for TracedFuture<F>

fn drop(&mut self)

Executes the destructor for this type.

impl<F> Future for TracedFuture<F>

where F: Future,

type Output = <F as Future>::Output

The type of value produced on completion.

fn poll( self: Pin<&mut TracedFuture<F>>, cx: &mut Context<'_>, ) -> Poll<<TracedFuture<F> as Future>::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.