Struct ConstantBuilder

pub struct ConstantBuilder { /* private fields */ }

ConstantBuilder is used to create a [ConstantBackoff], providing a steady delay with a fixed number of retries.

Default

• delay: 1s
• max_times: 3

Examples

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

    Ok(())
}

Implementations

impl ConstantBuilder

pub fn with_delay(self, delay: Duration) -> Self

Set the delay for the backoff.

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

Set the maximum number of attempts to be made.

pub fn with_jitter(self) -> Self

Set jitter for the backoff.

Jitter is a random value added to the delay to prevent a thundering herd problem.

pub fn without_max_times(self) -> Self

Set no max times for the backoff.

The backoff will not stop by itself.

The backoff could stop reaching usize::MAX attempts but this is unrealistic.

Trait Implementations

impl BackoffBuilder for &ConstantBuilder

type Backoff = ConstantBackoff

The associated backoff returned by this builder.

fn build(self) -> Self::Backoff

Construct a new backoff using the builder.

impl BackoffBuilder for ConstantBuilder

type Backoff = ConstantBackoff

The associated backoff returned by this builder.

fn build(self) -> Self::Backoff

Construct a new backoff using the builder.

impl Clone for ConstantBuilder

fn clone(&self) -> ConstantBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConstantBuilder

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

Formats the value using the given formatter.

impl Default for ConstantBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Copy for ConstantBuilder