IGI-111 / retry-block

utilities to retry operations that may fail with configurable backoff behavior using macros over blocks of code

retry-block

retry-block provides utilities to retry operations that may fail with configurable backoff behavior using macros over blocks of code

Usage

Retry an operation using the corresponding retry macro or retry_fn function.

let mut tried = false;
let value = retry!(
    // an `IntoIterator<Item = Duration>`
    Fixed::new(Duration::from_millis(1)),

    // a block that returns an `Into<OperationResult<_, _>>`
    {
        if tried {
            Ok(42)
        } else {
            tried = true;
            Err("try again")
        }

    }
).unwrap();

assert_eq!(value, 42);

#[tokio::main]
async fn main() {
    let mut tried = false;

    let value = async_retry!(
        // an `IntoIterator<Item = Duration>`
        Fixed::new(Duration::from_millis(1)),

        // a block that returns an `Into<OperationResult<_, _>>`
        {
            if tried {
                Ok(42)
            } else {
                tried = true;
                Err("try again")
            }
        }
    );
    assert_eq!(value, Ok(42));
}

The macro accepts an iterator over Durations and a block that returns a Result (or OperationResult if you want to explicitly control the retry/bail behavior). The iterator is used to determine how long to wait after each unsuccessful try and how many times to try before giving up and returning Result::Err. The block determines either the final successful value, or an error value, which can either be returned immediately or used to indicate that the operation should be retried.

Any type that implements IntoIterator<Item = Duration> can be used to determine retry behavior, though a few useful implementations are provided in the delay module, including a fixed delay and exponential back-off.

The Iterator API can be used to limit or modify the delay strategy. For example, to limit the number of retries to 1:

let mut collection = vec![1, 2, 3].into_iter();

let result = retry!(Fixed::new(Duration::from_millis(100)).take(1), {
    match collection.next() {
        Some(n) if n == 3 => Ok("n is 3!"),
        Some(_) => Err("n must be 3!"),
        None => Err("n was never 3!"),
    }
});

assert!(result.is_err());