Struct backon::ExponentialBuilder

pub struct ExponentialBuilder { /* private fields */ }

ExponentialBuilder is used to build a ExponentialBackoff

Default

• jitter: false
• factor: 2
• min_delay: 1s
• max_delay: 60s
• max_times: 3

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()).await?;
    println!("fetch succeeded: {}", content);

    Ok(())
}

Implementations

impl ExponentialBuilder

pub fn with_jitter(self) -> Self

Set jitter of current backoff.

If jitter is enabled, ExponentialBackoff will add a random jitter in `[0, min_delay) to current delay.

pub fn with_factor(self, factor: f32) -> Self

Set factor of current backoff.

Panics

This function will panic if input factor smaller than 1.0.

pub fn with_min_delay(self, min_delay: Duration) -> Self

Set min_delay of current backoff.

pub fn with_max_delay(self, max_delay: Duration) -> Self

Set max_delay of current backoff.

Delay will not increasing if current delay is larger than max_delay.

pub fn with_max_times(self, max_times: usize) -> Self

Set max_times of current backoff.

Backoff will return None if max times is reaching.

Trait Implementations

impl BackoffBuilder for ExponentialBuilder

type Backoff = ExponentialBackoff

The associated backoff that returned by this builder.

fn build(&self) -> Self::Backoff

Builder a new backoff via builder.

impl Clone for ExponentialBuilder

fn clone(&self) -> ExponentialBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExponentialBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExponentialBuilder

fn default() -> Self

Returns the “default value” for a type.