Retry-If

基于谓词的retry装饰器，用于使用指数退避策略重试任意函数。

此库旨在使装饰代码使用重试策略尽可能简单，所需的所有内容只是一个定义的重试策略和一个确定代码输出是否需要重试的函数。

示例：在Err(...)上重试Result生产函数

以下示例设置了一个基本的重试配置，将最多重试五次，第一次等待1秒，然后2秒，4秒等。没有配置所有尝试的最大重试时间（t_wait_max），也没有配置每个退避的最大等待时间（backoff_max）。

use retry_if::{retry, ExponentialBackoffConfig};
use std::num::TryFromIntError;
use std::time::Duration;
use tokio::time::{pause, Instant};

const BACKOFF_CONFIG: ExponentialBackoffConfig = ExponentialBackoffConfig {
    max_retries: 5,
    t_wait: Duration::from_secs(1),
    backoff: 2.0,
    t_wait_max: None,
    backoff_max: None,
};

// this takes an address of the same type as the output of the decorated function.
//  It returns true if the function should be retried based on the result
fn retry_if(result: &Result<i64, TryFromIntError>) -> bool {
    result.is_err()
}

#[retry(BACKOFF_CONFIG, retry_if)]
async fn fallible_call() -> Result<i64, TryFromIntError> {
    // this will always produce a TryFromIntError, triggering a retry
    i64::try_from(i128::MAX)
}

#[tokio::main]
async fn main() {
    let start = Instant::now();

    let _ = fallible_call().await;

    let end = Instant::now();

    let elapsed = end - start;

    // expected waits are 1s, 2s, 4s, 8s, 16s = 31s
    assert!(elapsed > Duration::from_secs(31));
    assert!(elapsed < Duration::from_millis(31100));

    println!("Total test time: {elapsed:?}");
}

跟踪

该crate将tracing作为功能暴露出来，以启用使用tokio tracing库的tracing::info!进行日志记录，为每次重试尝试。这些目前的形式为：Sleeping {Duration:?} on attempt {i32}。输出跟踪将采用父函数提供的任何仪器范围。

限制

#[retry(...)]可以装饰几乎所有的异步函数。这包括

struct Thing {}

struct Other {}

impl Thing {
    #[retry(...)]
    async fn to_thing(self) -> Other {
        self.into()
    }
}

struct Thing {}

struct Other {}

impl Thing {
    #[retry(...)]
    async fn do_thing(self) -> Option<i32> {
        // compilation fails here because this is expanded to match on `get_data()` and the match arms are Ok & Err
        //  instead of Some & None
        let data = get_data()?;
        data * 2
    }
}