Struct LabeledFuture 

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

A future that records poll events with a source label into a shared Trace.

Unlike TracedFuture, LabeledFuture pushes events into a caller-supplied Trace (wrapped in Arc<Mutex<_>>), allowing multiple labeled futures to contribute to a single trace with a shared time origin.

If the wrapped future is dropped before completing, a final PollResult::Cancelled event is recorded.

Examples

use async_reify::{LabeledFuture, Trace};

let trace = Trace::shared();
let fut = LabeledFuture::new(async { 42 }, "fetch_data", trace.clone());
let val = fut.await;
assert_eq!(val, 42);
assert_eq!(
    trace.lock().unwrap().events[0].label.as_deref(),
    Some("fetch_data"),
);

Implementations

impl<F> LabeledFuture<F>

where F: Future,

pub fn new(inner: F, label: &str, trace: Arc<Mutex<Trace>>) -> LabeledFuture<F>

Create a labeled future that logs to the shared Trace.

Examples

use async_reify::{LabeledFuture, Trace};

let trace = Trace::shared();
let _fut = LabeledFuture::new(async { 1 }, "step_1", trace);

Trait Implementations

impl<F> Drop for LabeledFuture<F>

fn drop(&mut self)

Executes the destructor for this type.

impl<F> Future for LabeledFuture<F>

where F: Future,

type Output = <F as Future>::Output

The type of value produced on completion.

fn poll( self: Pin<&mut LabeledFuture<F>>, cx: &mut Context<'_>, ) -> Poll<<LabeledFuture<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.