Trait SleepProvider 

pub trait SleepProvider {
    type Sleep: Future<Output = ()> + Send;

    // Required method
    fn sleep_for(dur: Duration) -> Self::Sleep;
}

Available on crate feature futures only.

A trait that abstracts over how to sleep for a given Duration in async contexts.

This allows the generator to be generic over runtimes like Tokio or Smol.

Required Associated Types

type Sleep: Future<Output = ()> + Send

We require Send so that the future can be safely moved across threads

Required Methods

fn sleep_for(dur: Duration) -> Self::Sleep

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl SleepProvider for SmolSleep

Available on crate feature async-smol and (crate features async-tokio or async-smol) only.

type Sleep = SmolSleepFuture

impl SleepProvider for SmolYield

Available on crate feature async-smol and (crate features async-tokio or async-smol) only.

type Sleep = YieldNow

impl SleepProvider for TokioSleep

Available on crate feature async-tokio and (crate features async-tokio or async-smol) only.

type Sleep = Sleep

impl SleepProvider for TokioYield

Available on crate feature async-tokio and (crate features async-tokio or async-smol) only.

type Sleep = Pin<Box<dyn Future<Output = ()> + Send>>