Struct hedwig::googlepubsub::retry_policy::exponential_backoff::Config

pub struct Config {
    pub initial_interval: Duration,
    pub max_interval: Duration,
    pub multiplier: f32,
    pub max_retries: Option<usize>,
    pub randomization_factor: f32,
}

This is supported on crate feature google only.

Configuration values for ExponentialIter

Fields

initial_interval: Duration

The initial delay before the first retry attempt is made

max_interval: Duration

The maximum delay between retry attempts.

Once this interval is reached, the exponential growth will stop and this value will be returned for all subsequent polls

multiplier: f32

The multiplication factor for the exponential growth.

The delay between each retry attempt will increase by this factor for each attempted retry

max_retries: Option<usize>

The number of times that retry attemps will be made before the underlying error is returned

A value of None will cause the retries to continue indefinitely

randomization_factor: f32

The multiplication factor controlling the randomization applied to the retry intervals.

Each retry interval will be randomly selected from a time span around the calculated exponential interval. That time span’s length is determined by multiplying the calculated interval by this randomization factor, then creating a range of twice that length centered on the calculated interval. For example, with a calculated interval of 20ms and a randomization factor of 0.5, the potential range of the output interval would be [20 * (1 - 0.5), 20 * (1 + 0.5)] or 10ms..=30ms.

This value must be at least zero and no greater than 1. Setting the value to zero will essentially disable the randomization such that only the calculated exponential intervals are used.

Implementations

impl Config

pub fn new() -> Config

Construct a new instance with the default values

pub fn initial_interval(self, initial_interval: Duration) -> Config

Set this field to the given value

pub fn max_interval(self, max_interval: Duration) -> Config

Set this field to the given value

pub fn multiplier(self, multiplier: f32) -> Config

Set this field to the given value

pub fn max_retries(self, max_retries: Option<usize>) -> Config

Set this field to the given value

pub fn randomization_factor(self, randomization_factor: f32) -> Config

Set this field to the given value

Trait Implementations

impl Clone for Config

pub fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

pub fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Config, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Copy for Config