Struct RetryPolicy 

#[non_exhaustive]
pub struct RetryPolicy {
    pub max_attempts: u32,
    pub initial_delay: Duration,
    pub max_delay: Duration,
}

Available on crate feature client only.

How a failed GET is retried.

Writes are never retried; see OcpiRequest::is_retryable.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_attempts: u32

Total attempts, including the first. 1 disables retrying.

initial_delay: Duration

The delay before the first retry.

max_delay: Duration

The cap on the exponentially growing delay.

Implementations

impl RetryPolicy

pub fn delay_for(&self, attempt: u32, seed: u64) -> Duration

How long to wait before attempt attempt (1-based, so the first retry is attempt 2), for the request identified by seed.

The delay is exponential — initial_delay * 2^(attempt-1), capped at max_delay — with equal jitter: the value actually returned is drawn from the upper half of that interval, [base/2, base].

seed is what makes the jitter useful. A schedule computed from the attempt number alone is identical on every client in a fleet, so a peer that has just come back from an outage is hit by all of them at the same instant — the thundering herd that jitter exists to prevent. Pass something that differs per client and per request; RetryPolicy::seed_from derives one from the request’s X-Request-ID, which is a freshly generated UUID and therefore already carries the entropy needed.

pub fn seed_from(request_id: &str) -> u64

A delay_for seed derived from a request id.

impl RetryPolicy

pub const fn none() -> Self

A policy that never retries.

Trait Implementations

impl Clone for RetryPolicy

fn clone(&self) -> RetryPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RetryPolicy

impl Debug for RetryPolicy

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

Formats the value using the given formatter.

impl Default for RetryPolicy

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RetryPolicy

impl PartialEq for RetryPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RetryPolicy