Struct RetryPolicy 

pub struct RetryPolicy { /* private fields */ }

Retry policy covering attempts, backoff, and retryable failure classes.

See also:

• examples/resilience_controls.rs
• examples/retry_classifier.rs

Example

use std::time::Duration;

use reqx::prelude::RetryPolicy;
use reqx::TransportErrorKind;

let policy = RetryPolicy::standard()
    .max_attempts(4)
    .base_backoff(Duration::from_millis(100))
    .max_backoff(Duration::from_secs(1))
    .transport_retry_window(TransportErrorKind::Connect, 2);

let _ = policy;

Implementations

impl RetryPolicy

pub fn disabled() -> Self

Returns a policy that disables retries.

pub fn standard() -> Self

Returns the default SDK retry policy.

pub fn max_attempts(self, max_attempts: usize) -> Self

Sets the maximum number of attempts, including the first try.

pub fn base_backoff(self, base_backoff: Duration) -> Self

Sets the base exponential backoff delay.

pub fn max_backoff(self, max_backoff: Duration) -> Self

Sets the maximum backoff delay.

pub fn jitter_ratio(self, jitter_ratio: f64) -> Self

Sets the random jitter ratio applied to computed backoffs.

pub fn retryable_status_codes( self, codes: impl IntoIterator<Item = u16>, ) -> Self

Replaces the set of retryable HTTP status codes.

pub fn retryable_transport_error_kinds( self, kinds: impl IntoIterator<Item = TransportErrorKind>, ) -> Self

Replaces the set of retryable transport error kinds.

pub fn retryable_timeout_phases( self, phases: impl IntoIterator<Item = TimeoutPhase>, ) -> Self

Replaces the set of retryable timeout phases.

pub fn retry_on_response_body_read_error(self, retry: bool) -> Self

Enables or disables retries after response body read failures.

pub fn status_retry_window(self, status: u16, max_attempts: usize) -> Self

Sets a per-status retry window measured in maximum attempts.

pub fn transport_retry_window( self, kind: TransportErrorKind, max_attempts: usize, ) -> Self

Sets a per-transport-kind retry window measured in maximum attempts.

pub fn timeout_retry_window( self, phase: TimeoutPhase, max_attempts: usize, ) -> Self

Sets a per-timeout-phase retry window measured in maximum attempts.

pub fn response_body_read_retry_window(self, max_attempts: usize) -> Self

Sets the retry window for response body read failures.

pub fn retry_classifier( self, retry_classifier: Arc<dyn RetryClassifier>, ) -> Self

Sets a custom classifier that can override the built-in retry rules.

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 Debug for RetryPolicy

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

Formats the value using the given formatter.

impl Default for RetryPolicy

fn default() -> Self

Returns the “default value” for a type.