Struct backon::BlockingRetry

source ·
pub struct BlockingRetry<B: Backoff, T, E, F: FnMut() -> Result<T, E>, RF = fn(_: &E) -> bool, NF = fn(_: &E, _: Duration)> { /* private fields */ }
Expand description

Retry struct generated by [Retryable].

Implementations§

source§

impl<B, T, E, F, RF, NF> BlockingRetry<B, T, E, F, RF, NF>
where B: Backoff, F: FnMut() -> Result<T, E>, RF: FnMut(&E) -> bool, NF: FnMut(&E, Duration),

source

pub fn when<RN: FnMut(&E) -> bool>( self, retryable: RN ) -> BlockingRetry<B, T, E, F, RN, NF>

Set the conditions for retrying.

If not specified, we treat all errors as retryable.

§Examples
use anyhow::Result;
use backon::BlockingRetryable;
use backon::ExponentialBuilder;

fn fetch() -> Result<String> {
    Ok("hello, world!".to_string())
}

fn main() -> Result<()> {
    let retry = fetch
        .retry(&ExponentialBuilder::default())
        .when(|e| e.to_string() == "EOF");
    let content = retry.call()?;
    println!("fetch succeeded: {}", content);

    Ok(())
}
source

pub fn notify<NN: FnMut(&E, Duration)>( self, notify: NN ) -> BlockingRetry<B, T, E, F, 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::BlockingRetryable;
use backon::ExponentialBuilder;

fn fetch() -> Result<String> {
    Ok("hello, world!".to_string())
}

fn main() -> Result<()> {
    let retry = fetch.retry(&ExponentialBuilder::default()).notify(
        |err: &anyhow::Error, dur: Duration| {
            println!("retrying error {:?} with sleeping {:?}", err, dur);
        },
    );
    let content = retry.call()?;
    println!("fetch succeeded: {}", content);

    Ok(())
}
source

pub fn call(self) -> Result<T, E>

Call the retried function.

TODO: implment std::ops::FnOnce after it stable.

Auto Trait Implementations§

§

impl<B, T, E, F, RF, NF> Freeze for BlockingRetry<B, T, E, F, RF, NF>
where F: FnOnce() + Freeze, B: Unpin + Sync + Send + Iterator<Item = Duration> + Freeze, RF: Freeze, NF: Freeze,

§

impl<B, T, E, F, RF, NF> RefUnwindSafe for BlockingRetry<B, T, E, F, RF, NF>

§

impl<B, T, E, F, RF, NF> Send for BlockingRetry<B, T, E, F, RF, NF>
where F: FnOnce() + Send, B: Unpin + Sync + Send + Iterator<Item = Duration>, RF: Send, NF: Send,

§

impl<B, T, E, F, RF, NF> Sync for BlockingRetry<B, T, E, F, RF, NF>
where F: FnOnce() + Sync, B: Unpin + Sync + Send + Iterator<Item = Duration>, RF: Sync, NF: Sync,

§

impl<B, T, E, F, RF, NF> Unpin for BlockingRetry<B, T, E, F, RF, NF>
where F: FnOnce() + Unpin, B: Unpin + Sync + Send + Iterator<Item = Duration>, RF: Unpin, NF: Unpin,

§

impl<B, T, E, F, RF, NF> UnwindSafe for BlockingRetry<B, T, E, F, RF, NF>
where F: FnOnce() + UnwindSafe, B: Unpin + Sync + Send + Iterator<Item = Duration> + UnwindSafe, RF: UnwindSafe, NF: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.