Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
pub struct RetryPolicy {
    pub max_attempts: u32,
    pub base_delay: f64,
    pub max_delay: f64,
    pub multiplier: f64,
    pub jitter: f64,
    pub retry_on: Option<Arc<dyn Fn(&(dyn Error + 'static)) -> bool + Send + Sync>>,
}
Expand description

How to retry factory.create(): exponential backoff with jitter.

jitter in [0, 1]: 0 = deterministic delays, 1 = “full jitter” (uniform in [0, delay]). retry_on narrows what is retryable (e.g. don’t retry auth failures); None means retry everything.

Fields§

§max_attempts: u32

Maximum attempts (including the first). 1 = no retries.

§base_delay: f64

Base delay in seconds for the first retry.

§max_delay: f64

Upper bound on any single delay, in seconds.

§multiplier: f64

Exponential growth factor between attempts.

§jitter: f64

Jitter fraction in [0, 1].

§retry_on: Option<Arc<dyn Fn(&(dyn Error + 'static)) -> bool + Send + Sync>>

Optional predicate: retry only when it returns true. None = retry everything.

Implementations§

Source§

impl RetryPolicy

Source

pub fn no_retry() -> Self

A policy that never retries (one attempt only).

Source

pub fn with_retry_on<F>(self, predicate: F) -> Self
where F: Fn(&(dyn Error + 'static)) -> bool + Send + Sync + 'static,

Returns a copy with retry_on set to predicate.

Source

pub fn validate(&self) -> Result<(), PoolError>

Checks the policy’s invariants.

Source

pub fn should_retry(&self, err: &(dyn Error + 'static)) -> bool

Reports whether err is retryable under this policy.

Source

pub fn delay_for(&self, failed_attempts: u32, rng: &mut dyn Rng) -> f64

The delay before the next attempt, given how many attempts have failed so far (failed_attempts is 1-based: pass 1 after the first failure).

Trait Implementations§

Source§

impl Clone for RetryPolicy

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RetryPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RetryPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.