Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
#[non_exhaustive]
pub struct RetryPolicy { pub max_retries: u32, pub backoff_initial: Duration, pub backoff_max: Duration, pub backoff_jitter: f64, pub timeout: Duration, pub respect_retry_after: bool, pub max_retry_after: Duration, pub retry_connection_errors: bool, pub retry_timeouts: bool, pub retry_statuses: Vec<u16>, }
Expand description

How failed requests are retried.

The defaults match the official TypeSafe SDKs: 2 retries, a 0.5 s first delay doubling up to 5 s, a quarter of each delay randomly subtracted, a 30 s timeout per attempt, and a server’s Retry-After honoured up to 60 s. Retried by default are 408, 429, every 5xx (so 529 too), connection failures and timeouts.

use std::time::Duration;
use jev_client::RetryPolicy;

let patient = RetryPolicy::default().with_max_retries(5).with_timeout(Duration::from_secs(60));
assert_eq!(patient.max_retries, 5);

let never = RetryPolicy::none();
assert_eq!(never.max_retries, 0);

Fields (Non-exhaustive)§

This struct is marked as 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_retries: u32

Retries after the first attempt. 0 disables retrying.

§backoff_initial: Duration

The delay before the first retry. Each later delay doubles, up to backoff_max.

§backoff_max: Duration

The longest backoff delay.

§backoff_jitter: f64

The fraction of each backoff delay that is randomly subtracted, from 0 to 1. Spreading retries out stops many clients from retrying in step.

§timeout: Duration

The time allowed for one attempt, from sending the request to reading the whole response.

§respect_retry_after: bool

Whether a Retry-After or retry-after-ms response header sets the delay.

§max_retry_after: Duration

The longest server-requested delay that is honoured. A longer one falls back to backoff.

§retry_connection_errors: bool

Whether a failure to connect, or a connection lost mid-response, is retried.

§retry_timeouts: bool

Whether an attempt that timed out is retried.

§retry_statuses: Vec<u16>

The HTTP statuses that are retried. 400, 401, 403, 404 and 422 are never retried, even when listed here.

Implementations§

Source§

impl RetryPolicy

Source

pub fn none() -> Self

The default policy with retrying switched off. The per-attempt timeout still applies.

Source

pub const fn with_max_retries(self, max_retries: u32) -> Self

Sets the number of retries after the first attempt.

Source

pub const fn with_backoff(self, initial: Duration, max: Duration) -> Self

Sets the first backoff delay and the longest one.

Source

pub const fn with_jitter(self, fraction: f64) -> Self

Sets the fraction of each backoff delay that is randomly subtracted. Values outside 0 to 1, and NaN, are clamped into range when a delay is computed.

Source

pub const fn with_timeout(self, timeout: Duration) -> Self

Sets the time allowed for one attempt.

Source

pub fn retries_status(&self, status: u16) -> bool

Returns true when a response with status should be retried under this policy.

Source

pub fn backoff_delay(&self, retry: u32, random: f64) -> Duration

The backoff delay before retry number retry (0 for the first retry).

random is a sample from 0 to 1 that decides how much of the jitter is applied; passing it in keeps this function pure.

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
Source§

impl PartialEq for RetryPolicy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RetryPolicy

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more