#backoff #retry #exponential #policy

backoff

Retry operations with exponential backoff policy

10 releases

0.3.0 Feb 2, 2021
0.3.0-alpha.1 Feb 1, 2021
0.2.1 Jul 15, 2020
0.1.6 Jan 19, 2020
0.1.2 May 28, 2017

#12 in Network programming

Download history 12155/week @ 2021-02-23 11626/week @ 2021-03-02 11514/week @ 2021-03-09 19228/week @ 2021-03-16 21909/week @ 2021-03-23 20017/week @ 2021-03-30 23375/week @ 2021-04-06 22021/week @ 2021-04-13 18839/week @ 2021-04-20 19811/week @ 2021-04-27 19640/week @ 2021-05-04 20486/week @ 2021-05-11 16922/week @ 2021-05-18 16761/week @ 2021-05-25 15518/week @ 2021-06-01 15854/week @ 2021-06-08

76,510 downloads per month
Used in 65 crates (39 directly)

MIT/Apache

33KB
457 lines

backoff

Exponential backoff and retry.

Inspired by the retry mechanism in Google's google-http-java-client library and its Golang port.

Build Status crates.io Documentation

Compile with feature wasm-bindgen or stdweb for use in WASM environments. retry_notify is not yet supported, as it uses std::thread::sleep.

⚠️ BREAKING CHANGES: migration instructions under Breaking changes.

Overview

backoff is small crate which allows you to retry operations according to backoff policies. It provides:

  • Error type to wrap errors as either transient of permanent,
  • different backoff algorithms, including exponential,
  • supporting both sync and async code.

Sync example

Just wrap your fallible operation into a closure, and pass it into retry:

use backoff::{retry, ExponentialBackoff, Error};

let op = || {
    reqwest::blocking::get("http://example.com").map_err(Error::Transient)
};

let _ = retry(&mut ExponentialBackoff::default(), op);

The retry policy will use jitters according to the randomization_factor field of ExponentialBackoff. Check the documentation for more parameters.

Async example

Futures are supported by the futures module:

use backoff::ExponentialBackoff;
use backoff::future::retry;

async fn fetch_url(url: &str) -> Result<String, reqwest::Error> {
    retry(ExponentialBackoff::default(), || async {
        println!("Fetching {}", url);
        Ok(reqwest::get(url).await?.text().await?)
    })
    .await
}

Breaking changes

0.2.x -> 0.3.x

Removal of Operation trait

https://github.com/ihrwein/backoff/pull/28

The Operation trait has been removed, please use normal closures implementing FnMut instead. The retry and retry_notify methods were converted to free functions, available in the crate's root.

Example.

Removal of FutureOperation trait

https://github.com/ihrwein/backoff/pull/28

The FutureOperation trait has been removed. The retry and retry_notify methods were converted to free functions, available in the crate's root.

Example.

Changes in feature flags

  • stdweb flag was removed, as the project is abandoned.

retry, retry_notify taking ownership of Backoff instances (previously &mut)

Example.

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the Work by You, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0.3–1.6MB
~30K SLoC