19 releases (6 stable)
new 1.3.0 | Nov 22, 2024 |
---|---|
1.1.0 | Aug 29, 2024 |
0.5.0 | Aug 22, 2024 |
0.4.4 | Apr 8, 2024 |
0.0.2 | Apr 14, 2022 |
#42 in Rust patterns
266,896 downloads per month
Used in 203 crates
(24 directly)
91KB
1.5K
SLoC
BackON
Make retry like a built-in feature provided by Rust.
- Simple: Just like a built-in feature:
your_fn.retry(ExponentialBuilder::default()).await
. - Flexible: Supports both blocking and async functions.
- Powerful: Allows control over retry behavior such as
when
andnotify
. - Customizable: Supports custom retry strategies like exponential, constant, etc.
- Adaptable: Works on all platforms supported by Rust, including both
wasm
andno-std
.
Quick Start
Retry an async function.
use anyhow::Result;
use backon::ExponentialBuilder;
use backon::Retryable;
async fn fetch() -> Result<String> {
Ok("hello, world!".to_string())
}
#[tokio::main]
async fn main() -> Result<()> {
let content = fetch
// Retry with exponential backoff
.retry(ExponentialBuilder::default())
// Sleep implementation, required if no feature has been enabled
.sleep(tokio::time::sleep)
// When to retry
.when(|e| e.to_string() == "EOF")
// Notify when retrying
.notify(|err: &anyhow::Error, dur: Duration| {
println!("retrying {:?} after {:?}", err, dur);
})
.await?;
println!("fetch succeeded: {}", content);
Ok(())
}
Retry a blocking function.
use anyhow::Result;
use backon::BlockingRetryable;
use backon::ExponentialBuilder;
fn fetch() -> Result<String> {
Ok("hello, world!".to_string())
}
fn main() -> Result<()> {
let content = fetch
// Retry with exponential backoff
.retry(ExponentialBuilder::default())
// Sleep implementation, required if no feature has been enabled
.sleep(std::thread::sleep)
// When to retry
.when(|e| e.to_string() == "EOF")
// Notify when retrying
.notify(|err: &anyhow::Error, dur: Duration| {
println!("retrying {:?} after {:?}", err, dur);
})
.call()?;
println!("fetch succeeded: {}", content);
Ok(())
}
Contributing
Check out the CONTRIBUTING.md guide for more details on getting started with contributing to this project.
Getting help
Submit issues for bug report or asking questions in discussion.
License
Licensed under Apache License, Version 2.0.
Dependencies
~0–5.5MB
~24K SLoC