Struct BlockingRetryWithContext

pub struct BlockingRetryWithContext<B, T, E, Ctx, F, SF = PleaseEnableAFeatureOrProvideACustomSleeper, RF = fn(_: &E) -> bool, NF = fn(_: &E, _: Duration)>
where
    B: Backoff,
    F: FnMut(Ctx) -> (Ctx, Result<T, E>),
    SF: MaybeBlockingSleeper,
{ /* private fields */ }

Retry structure generated by BlockingRetryableWithContext.

Implementations

impl<B, T, E, Ctx, F, SF, RF, NF> BlockingRetryWithContext<B, T, E, Ctx, F, SF, RF, NF>

where B: Backoff, F: FnMut(Ctx) -> (Ctx, Result<T, E>), SF: MaybeBlockingSleeper, RF: FnMut(&E) -> bool, NF: FnMut(&E, Duration),

pub fn context( self, context: Ctx, ) -> BlockingRetryWithContext<B, T, E, Ctx, F, SF, RF, NF>

Set the context for retrying.

Context is used to capture ownership manually to prevent lifetime issues.

pub fn sleep<SN>( self, sleep_fn: SN, ) -> BlockingRetryWithContext<B, T, E, Ctx, F, SN, RF, NF>

where SN: BlockingSleeper,

Set the sleeper for retrying.

The sleeper should implement the BlockingSleeper trait. The simplest way is to use a closure like Fn(Duration).

If not specified, we use the DefaultBlockingSleeper.

pub fn when<RN>( self, retryable: RN, ) -> BlockingRetryWithContext<B, T, E, Ctx, F, SF, RN, NF>

where RN: FnMut(&E) -> bool,

Set the conditions for retrying.

If not specified, all errors are considered retryable.

pub fn notify<NN>( self, notify: NN, ) -> BlockingRetryWithContext<B, T, E, Ctx, F, SF, RF, NN>

where NN: FnMut(&E, Duration),

Set to notify for all retry attempts.

When a retry happens, the input function will be invoked with the error and the sleep duration before pausing.

If not specified, this operation does nothing.

impl<B, T, E, Ctx, F, SF, RF, NF> BlockingRetryWithContext<B, T, E, Ctx, F, SF, RF, NF>

where B: Backoff, F: FnMut(Ctx) -> (Ctx, Result<T, E>), SF: BlockingSleeper, RF: FnMut(&E) -> bool, NF: FnMut(&E, Duration),

pub fn call(self) -> (Ctx, Result<T, E>)

Call the retried function.

TODO: implement FnOnce after it stable.