exponential-backoff

Crates.ioexponential-backoff
lib.rsexponential-backoff
version1.2.0
sourcesrc
created_at2018-07-11 15:30:03.089507
updated_at2023-01-30 12:25:55.547998
descriptionA small and flexible backoff function
homepage
repositoryhttps://github.com/yoshuawuyts/exponential-backoff
max_upload_size
id73777
size30,395
Yosh (yoshuawuyts)

documentation

https://docs.rs/exponential-backoff

README

exponential-backoff

crates.io version build status downloads docs.rs docs

Exponential backoff generator. Serves as a building block to implement custom retry functions.

Why?

When an network requests times out, often the best way to solve it is to try again. But trying again straight away might at best cause some network overhead, and at worst a full fledged DDOS. So we have to be responsible about it.

A good explanation of retry strategies can be found on the Stripe blog.

Usage

Here we try and read a file from disk, and try again if it fails. A more realistic scenario would probably to perform an HTTP request, but the approach should be similar.

use exponential_backoff::Backoff;
use std::{fs, thread, time::Duration};

let retries = 8;
let min = Duration::from_millis(100);
let max = Duration::from_secs(10);
let backoff = Backoff::new(retries, min, max);

for duration in &backoff {
    match fs::read_to_string("README.md") {
        Ok(string) => return Ok(string),
        Err(err) => match duration {
            Some(duration) => thread::sleep(duration),
            None => return err,
        }
    }
}

Installation

$ cargo add exponential-backoff

See Also

Further Reading

License

MIT OR Apache-2.0

Commit count: 29

cargo fmt