Struct single_executor::SleepFutureRunner

pub struct SleepFutureRunner<Q, CS> where
    CS: TryThreadSpawner<()>,  { /* fields omitted */ }

Runs asynchronous sleep functions by launching a separate handler thread. Each new instance of this spawns a thread.

Implementations

impl<Q, CS> SleepFutureRunner<Q, CS> where
    Q: 'static + TimeoutQueue<Item = SleepMessage<CS>> + Send + Sync,
    CS: TryThreadSpawner<()> + TimeFunctions, 

pub fn try_new(queue: Q) -> Result<Self, CS::SpawnError>

Tries to create a new SleepFutureRunner by launching a thread.

pub fn new(queue: Q) -> Self where
    CS: ThreadSpawner<()>, 

Create a new SleepFutureRunner by launching a thread. Requires thread spawning to be infallible.

pub fn sleep_for(&self, time: Duration) -> impl Future<Output = ()> + '_

Creates a future that sleeps for a given duration from this call.

pub async fn sleep_until(&self, instant: CS::InstantType)

Creates a future that sleeps until a given CS::InstantType.

pub fn timeout_for<'a, T>(
    &'a self,
    future: impl Future<Output = T> + 'a,
    time: Duration
) -> impl Future<Output = Result<T, ()>> + 'a where
    T: 'a, 

Runs a given future with a timeout.

pub fn timeout_for_should_stop<'a, T, F>(
    &'a self,
    future: impl FnOnce(ShouldFinish) -> F + 'a,
    time: Duration
) -> impl Future<Output = Result<T, ()>> + 'a where
    T: 'a,
    F: Future<Output = T> + 'a, 

Runs a given future with a timeout. Allows for a should stop parameter.

pub async fn timeout_until<T>(
    &self,
    future: impl Future<Output = T>,
    instant: CS::InstantType
) -> Result<T, ()>

Runs a given future with a timeout.

pub async fn timeout_until_should_stop<T, F>(
    &self,
    future: impl FnOnce(ShouldFinish) -> F,
    instant: CS::InstantType
) -> Result<T, ()> where
    F: Future<Output = T>, 

Runs a given future with a timeout. Allows for a should stop parameter.

Trait Implementations

impl<Q: Debug, CS: Debug> Debug for SleepFutureRunner<Q, CS> where
    CS: TryThreadSpawner<()>, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.