Struct restartables::Restartable

pub struct Restartable<Fut, Test, Factory, T, E> where
    Fut: Future,
    Factory: Fn() -> Fut,
    Test: Fn(Fut::Output) -> Result<T, E>,  { /* fields omitted */ }

Wraps an inner future, restarting it until it resolves a value that passes a test, or times out.

This is a Future adaptor, meaning it wraps other futures, like future::map When this future is polled, it polls the inner future. If the inner futures resolves, its value is run through a test closure.

If the test is successful, the value is returned with timing information. If the test is unsuccessful, the future is recreated and retried. Because this fail-restart loop could go on forever, you should supply a timeout. If a None timeout is used, then awaiting the Restartable is not guaranteed to resolve.

Methods

impl<Fut, Test, Factory, T, E> Restartable<Fut, Test, Factory, T, E> where
    Fut: Future,
    Factory: Fn() -> Fut,
    Test: Fn(Fut::Output) -> Result<T, E>, 

pub fn new(factory: Factory, timeout: Option<Duration>, test: Test) -> Self

Trait Implementations

impl<Fut, Test, Factory, T, E> Future for Restartable<Fut, Test, Factory, T, E> where
    Fut: Future,
    Factory: Fn() -> Fut,
    Test: Fn(Fut::Output) -> Result<T, E>, 

type Output = Result<Success<T>, Failure<E>>

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.

impl<Fut, Test, Factory, T, E> PinnedDrop for Restartable<Fut, Test, Factory, T, E> where
    Fut: Future,
    Factory: Fn() -> Fut,
    Test: Fn(Fut::Output) -> Result<T, E>, 

unsafe fn drop(self: Pin<&mut Self>)

impl<'pin, Fut, Test, Factory, T, E> Unpin for Restartable<Fut, Test, Factory, T, E> where
    Fut: Future,
    Factory: Fn() -> Fut,
    Test: Fn(Fut::Output) -> Result<T, E>,
    __Restartable<'pin, Fut, Test, Factory, T, E>: Unpin,