zagreus 0.1.1

A featureful library for backoff handling
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

use std::{num::NonZeroU32, time::Duration};
///Types implementing `BackoffStrategy`.
pub mod strategies;

///Implementors are responsible for computing the interval between retries, as well as defining the
///limit to the number of retries that may be made.
///It is strongly recommended that implementors either be cheap to construct or, if shared state is needed, it be wrapped in an `Arc` or similar.
pub trait BackoffStrategy: Send + Sync {
    ///The interval computed for the attempts + 1 backoff.
    ///Returning Some(_) will progress the attempt loop once more with the contained Duration.
    ///Returning None will case the loop to halt immediately. This can be useful for implementing timeouts.
    fn interval(&self, attempts: u32) -> Option<Duration>;

    ///The maximum number of retries that may be attempted by a handle using this Strategy.
    fn limit(&self) -> NonZeroU32;
}