Struct single_executor::TimeoutFuture

pub struct TimeoutFuture<F>(_);

A future that can timeout.

Implementations

impl<F> TimeoutFuture<F>

pub fn new<Q, CS>(
    future: F,
    sleep_runner: &SleepFutureRunner<Q, CS>,
    timeout: Duration
) -> Self where
    Q: 'static + TimeoutQueue<Item = SleepMessage<CS>> + Send + Sync,
    CS: TimeFunctions + TryThreadSpawner<()>, 

Creates a new timeout future from a given future.

pub fn with_stop<Q, CS>(
    future_func: impl FnOnce(ShouldFinish) -> F,
    sleep_runner: &SleepFutureRunner<Q, CS>,
    timeout: Duration
) -> Self where
    Q: 'static + TimeoutQueue<Item = SleepMessage<CS>> + Send + Sync,
    CS: TimeFunctions + TryThreadSpawner<()>, 

Creates a new timeout future from a future function that takes an atomic bool that can be used to tell the future to stop when it times out.

Trait Implementations

impl<F: Debug> Debug for TimeoutFuture<F>

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

Formats the value using the given formatter.

impl<F> Future for TimeoutFuture<F> where
    F: Future, 

type Output = Result<F::Output, ()>

The type of value produced on completion.

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

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