https://github.com/xuanwo/backon
Make retry like a built-in feature provided by Rust.
https://github.com/xuanwo/backon
async backoff retry rust
Last synced: 5 months ago
JSON representation
Make retry like a built-in feature provided by Rust.
- Host: GitHub
- URL: https://github.com/xuanwo/backon
- Owner: Xuanwo
- License: apache-2.0
- Created: 2022-04-12T11:48:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-19T14:17:40.000Z (6 months ago)
- Last Synced: 2025-04-27T20:04:50.149Z (6 months ago)
- Topics: async, backoff, retry, rust
- Language: Rust
- Homepage: https://docs.rs/backon/
- Size: 271 KB
- Stars: 840
- Watchers: 4
- Forks: 40
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# BackON [![Build Status]][actions] [![Latest Version]][crates.io] [](https://discord.gg/8ARnvtJePD)
[Build Status]: https://img.shields.io/github/actions/workflow/status/Xuanwo/backon/ci.yml?branch=main
[actions]: https://github.com/Xuanwo/backon/actions?query=branch%3Amain
[Latest Version]: https://img.shields.io/crates/v/backon.svg
[crates.io]: https://crates.io/crates/backon
Make **retry** like a built-in feature provided by Rust.
- **Simple API**: Native feel: `your_fn.retry(ExponentialBuilder::default()).await`.
- **Sync & Async**: Supports both blocking and async operations seamlessly.
- **Precise Control**: Define when to retry and get notified via [`when`](https://docs.rs/backon/latest/backon/struct.Retry.html#method.when) and [`notify`](https://docs.rs/backon/latest/backon/struct.Retry.html#method.notify).
- **Custom Strategies**: Use built-in backoff strategies (exponential, constant) or define custom ones. Also supports dynamic backoff, such as using the HTTP `Retry-After` header.
- **Cross-Platform**: Works everywhere Rust does, including `wasm` & `no-std`.
---
## Quick Start
For more examples, check out the [examples](https://docs.rs/backon/latest/backon/docs/examples/index.html).
### Retry an async function.
```rust
use anyhow::Result;
use backon::ExponentialBuilder;
use backon::Retryable;
async fn fetch() -> Result {
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.
```rust
use anyhow::Result;
use backon::BlockingRetryable;
use backon::ExponentialBuilder;
fn fetch() -> Result {
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](./CONTRIBUTING.md) guide for more details on getting started with contributing to this
project.
## Getting help
Submit [issues](https://github.com/Xuanwo/backon/issues/new/choose) for bug report or asking questions
in [discussion](https://github.com/Xuanwo/backon/discussions/new?category=q-a).
## License
Licensed under Apache License, Version 2.0.