Struct exponential_backoff::Backoff

pub struct Backoff { /* private fields */ }

Exponential backoff type.

Implementations

impl Backoff

pub fn new( retries: u32, min: Duration, max: impl Into<Option<Duration>>, ) -> Self

Create a new instance.

Panics

This method panics if the retry count is set to 0.

pub fn set_min(&mut self, min: Duration)

Set the min duration.

pub fn set_max(&mut self, max: Option<Duration>)

Set the max duration.

pub fn set_jitter(&mut self, jitter: f32)

Set the amount of jitter per backoff.

Panics

This method panics if a number smaller than 0 or larger than 1 is provided.

pub fn set_factor(&mut self, factor: u32)

Set the growth factor for each iteration of the backoff.

pub fn next(&self, retry_attempt: u32) -> Option<Duration>

Get the next value for the retry count.

pub fn iter(&self) -> Iter<'_>

Create an iterator.

Trait Implementations

impl Clone for Backoff

fn clone(&self) -> Backoff

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Backoff

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

Formats the value using the given formatter.

impl<'b> IntoIterator for &'b Backoff

type Item = Duration

The type of the elements being iterated over.

type IntoIter = Iter<'b>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.