pub struct Retry<B: Backoff, T, E, Fut: Future<Output = Result<T, E>>, FutureFn: FnMut() -> Fut, RF = fn(_: &E) -> bool, NF = fn(_: &E, _: Duration)> { /* private fields */ }
Expand description
Retry struct generated by Retryable
.
Implementations§
source§impl<B, T, E, Fut, FutureFn, RF, NF> Retry<B, T, E, Fut, FutureFn, RF, NF>
impl<B, T, E, Fut, FutureFn, RF, NF> Retry<B, T, E, Fut, FutureFn, RF, NF>
sourcepub fn when<RN: FnMut(&E) -> bool>(
self,
retryable: RN
) -> Retry<B, T, E, Fut, FutureFn, RN, NF> ⓘ
pub fn when<RN: FnMut(&E) -> bool>( self, retryable: RN ) -> Retry<B, T, E, Fut, FutureFn, RN, NF> ⓘ
Set the conditions for retrying.
If not specified, we treat all errors as retryable.
§Examples
use anyhow::Result;
use backon::ExponentialBuilder;
use backon::Retryable;
async fn fetch() -> Result<String> {
Ok(reqwest::get("https://www.rust-lang.org")
.await?
.text()
.await?)
}
#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<()> {
let content = fetch
.retry(&ExponentialBuilder::default())
.when(|e| e.to_string() == "EOF")
.await?;
println!("fetch succeeded: {}", content);
Ok(())
}
sourcepub fn notify<NN: FnMut(&E, Duration)>(
self,
notify: NN
) -> Retry<B, T, E, Fut, FutureFn, RF, NN> ⓘ
pub fn notify<NN: FnMut(&E, Duration)>( self, notify: NN ) -> Retry<B, T, E, Fut, FutureFn, RF, NN> ⓘ
Set to notify for everything retrying.
If not specified, this is a no-op.
§Examples
use std::time::Duration;
use anyhow::Result;
use backon::ExponentialBuilder;
use backon::Retryable;
async fn fetch() -> Result<String> {
Ok(reqwest::get("https://www.rust-lang.org")
.await?
.text()
.await?)
}
#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<()> {
let content = fetch
.retry(&ExponentialBuilder::default())
.notify(|err: &anyhow::Error, dur: Duration| {
println!("retrying error {:?} with sleeping {:?}", err, dur);
})
.await?;
println!("fetch succeeded: {}", content);
Ok(())
}
Trait Implementations§
impl<'pin, B: Backoff, T, E, Fut: Future<Output = Result<T, E>>, FutureFn: FnMut() -> Fut, RF, NF> Unpin for Retry<B, T, E, Fut, FutureFn, RF, NF>where
__Retry<'pin, B, T, E, Fut, FutureFn, RF, NF>: Unpin,
Auto Trait Implementations§
impl<B, T, E, Fut, FutureFn, RF, NF> Freeze for Retry<B, T, E, Fut, FutureFn, RF, NF>
impl<B, T, E, Fut, FutureFn, RF = fn(_: &E) -> bool, NF = fn(_: &E, _: Duration)> !RefUnwindSafe for Retry<B, T, E, Fut, FutureFn, RF, NF>
impl<B, T, E, Fut, FutureFn, RF, NF> Send for Retry<B, T, E, Fut, FutureFn, RF, NF>
impl<B, T, E, Fut, FutureFn, RF, NF> Sync for Retry<B, T, E, Fut, FutureFn, RF, NF>
impl<B, T, E, Fut, FutureFn, RF = fn(_: &E) -> bool, NF = fn(_: &E, _: Duration)> !UnwindSafe for Retry<B, T, E, Fut, FutureFn, RF, NF>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<F> IntoFuture for Fwhere
F: Future,
impl<F> IntoFuture for Fwhere
F: Future,
§type IntoFuture = F
type IntoFuture = F
Which kind of future are we turning this into?
source§fn into_future(self) -> <F as IntoFuture>::IntoFuture
fn into_future(self) -> <F as IntoFuture>::IntoFuture
Creates a future from a value. Read more