Enum BackoffConfig

pub enum BackoffConfig {
    Constant {
        delay: DurationString,
        max_retries: Nullable<usize>,
        jitter_enabled: bool,
        jitter_seed: Option<u64>,
    },
    Exponential {
        initial_delay: DurationString,
        factor: f32,
        max_delay: Nullable<DurationString>,
        max_retries: Nullable<usize>,
        max_total_delay: Option<DurationString>,
        jitter_enabled: bool,
        jitter_seed: Option<u64>,
    },
    Fibonacci {
        initial_delay: DurationString,
        max_delay: Nullable<DurationString>,
        max_retries: Nullable<usize>,
        jitter_enabled: bool,
        jitter_seed: Option<u64>,
    },
}

Configuration for Backoff.

Variants

Constant

Configuration for Backoff::Constant.

Fields

delay: DurationString

Backoff delay.

Defaults to 500 millis - see defaults::delay.

max_retries: Nullable<usize>

Maximum amount of retries.

Removes the retry limit if the value is Nullable::Null.

Defaults to 4 - see defaults::max_retries.

jitter_enabled: bool

Whether jitter is enabled.

Defaults to true - see defaults::jitter_enabled.

jitter_seed: Option<u64>

Random seed to initialize the random jitter generator.

Defaults to None - see defaults::jitter_seed.

Exponential

Configuration for Backoff::Exponential.

Fields

initial_delay: DurationString

Initial backoff delay.

Defaults to 500 millis - see defaults::delay.

factor: f32

Backoff factor.

Defaults to 2.0 - see defaults::factor.

max_delay: Nullable<DurationString>

Maximum backoff delay.

Removes the max backoff delay limit if the value is Nullable::Null.

Defaults to 60 seconds - see defaults::max_delay.

max_retries: Nullable<usize>

Maximum amount of retries.

Removes the retry limit if the value is Nullable::Null.

Defaults to 4 - see defaults::max_retries.

max_total_delay: Option<DurationString>

Maximum total backoff delay.

Defaults to None - see defaults::max_total_delay

jitter_enabled: bool

Whether jitter is enabled.

Defaults to true - see defaults::jitter_enabled.

jitter_seed: Option<u64>

Random seed to initialize the random jitter generator.

Defaults to None - see defaults::jitter_seed.

Fibonacci

Configuration for Backoff::Fibonacci.

Fields

initial_delay: DurationString

Initial backoff delay.

Defaults to 500 millis - see defaults::delay.

max_delay: Nullable<DurationString>

Maximum backoff delay.

Removes the max backoff delay limit if the value is Nullable::Null.

Defaults to 60 seconds - see defaults::max_delay.

max_retries: Nullable<usize>

Maximum amount of retries.

Removes the retry limit if the value is Nullable::Null.

Defaults to 4 - see defaults::max_retries.

jitter_enabled: bool

Whether jitter is enabled.

Defaults to true - see defaults::jitter_enabled.

jitter_seed: Option<u64>

Random seed to initialize the random jitter generator.

Defaults to None - see defaults::jitter_seed.

Trait Implementations

impl BackoffBuilder for BackoffConfig

type Backoff = Backoff

The associated backoff returned by this builder.

fn build(self) -> Backoff

Construct a new backoff using the builder.

impl Clone for BackoffConfig

fn clone(&self) -> BackoffConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BackoffConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BackoffConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BackoffConfig

fn eq(&self, other: &BackoffConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BackoffConfig

impl StructuralPartialEq for BackoffConfig