Struct AsyncSleep 

pub struct AsyncSleep { /* private fields */ }

Runtime-agnostic async sleep future returned by async_sleep.

Polling the future for the first time spawns a single thread that parks for the requested duration and wakes the registered Waker when the deadline elapses. Subsequent polls return Poll::Pending until the waker is invoked, at which point the next poll returns Poll::Ready(()).

Used by the resilience decorator macros (#[retry], #[rate_limit], #[circuit_breaker]) when wrapped around an async fn. The sleep yields to the runtime for the full duration, never blocks the executor thread.

Implementations

impl AsyncSleep

pub fn new(dur: Duration) -> Self

Construct a sleep that completes after dur from “now”. The caller drives the future to completion via whatever executor it has in scope (Tokio / async-std / smol / custom).

pub fn remaining(&self) -> Duration

Time remaining until the deadline elapses. Returns Duration::ZERO once the deadline has passed.

Trait Implementations

impl Future for AsyncSleep

Available on crate feature serde only.

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()>

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