Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
pub struct RetryPolicy {
    pub max_retries: u32,
    pub backoff_initial: Duration,
    pub backoff_max: Duration,
    pub backoff_jitter: f64,
    pub http_statuses: BTreeSet<u16>,
    pub respect_retry_after: bool,
    pub max_retry_after: Duration,
    pub retry_connection_errors: bool,
    pub retry_timeouts: bool,
    pub total_budget: Option<Duration>,
}
Expand description

Configuration for retry behavior.

All fields are public. The Default value matches the SPEC and both official SDKs.

use std::time::Duration;
use typesafe_system_one::{Client, RetryPolicy};

let client = Client::builder()
    .api_key("key")
    .retry_policy(RetryPolicy {
        max_retries: 3,
        total_budget: Some(Duration::from_secs(10)),
        ..Default::default()
    })
    .build()
    .unwrap();

Fields§

§max_retries: u32

Maximum retries after the initial attempt; 0 disables retries.

§backoff_initial: Duration

First backoff delay, doubled each retry up to Self::backoff_max; zero disables backoff.

§backoff_max: Duration

Maximum backoff delay; zero disables backoff.

§backoff_jitter: f64

Fraction of each backoff delay randomly subtracted; between 0 and 1.

§http_statuses: BTreeSet<u16>

HTTP status codes that are retried.

§respect_retry_after: bool

Whether to honor retry-after-ms and Retry-After headers.

§max_retry_after: Duration

Maximum honored server retry delay; a longer delay falls back to backoff.

§retry_connection_errors: bool

Whether to retry connection errors (no HTTP response at all).

§retry_timeouts: bool

Whether to retry attempts that exceeded the per-attempt timeout.

§total_budget: Option<Duration>

Retry budget per call, measured from the first attempt; None or Some(Duration::ZERO) disables it.

A retry is not started when the elapsed time plus its delay would reach or exceed the budget; the call then returns the last real error rather than an artificial timeout, so the caller sees the actual 529. An attempt that has started runs to its own per-attempt timeout, so a call can overrun the budget by up to one timeout (the same semantics as the official Python SDK). For a hard bound, wrap the call in tokio::time::timeout.

Implementations§

Source§

impl RetryPolicy

Source

pub fn none() -> Self

A policy that never retries (max_retries = 0).

Source

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

Whether an HTTP status is retried under this policy.

Source

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

The pure backoff portion of the delay for retry retry_number (0-based), given a jitter random value in [0, 1).

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