Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
pub struct RetryPolicy {
    pub max_retries: usize,
    pub initial_delay: Duration,
    pub max_delay: Duration,
    pub backoff_multiplier: f64,
    pub jitter: f64,
    pub retry_on: RetryOn,
}
Expand description

Policy controlling RetryingChatClient backoff.

Delays grow exponentially from initial_delay by backoff_multiplier per attempt, are capped at max_delay, and are then reduced by up to jitter (a fraction of the delay). When the failing error carries a server Retry-After (see Error::retry_after) that value is used instead of the computed backoff (still capped by max_delay, and not jittered — it is an explicit server instruction).

Fields§

§max_retries: usize

Maximum number of retries after the initial attempt (default 3, so up to four total attempts).

§initial_delay: Duration

Base delay before the first retry (default 500ms).

§max_delay: Duration

Upper bound on any single delay, also capping a server Retry-After (default 30s).

§backoff_multiplier: f64

Exponential growth factor applied per retry (default 2.0).

§jitter: f64

Jitter as a fraction in 0.0..=1.0 (default 0.3): the computed delay is multiplied by 1 - jitter * r for a per-attempt random r in [0, 1). 0.0 disables jitter (fully deterministic delays).

§retry_on: RetryOn

Which errors to retry (default RetryOn::Default).

Implementations§

Source§

impl RetryPolicy

Source

pub fn with_max_retries(max_retries: usize) -> RetryPolicy

A policy with the given retry count and otherwise-default backoff.

Source

pub fn initial_delay(self, delay: Duration) -> RetryPolicy

Set the base delay before the first retry.

Source

pub fn max_delay(self, delay: Duration) -> RetryPolicy

Set the per-delay cap (also caps a server Retry-After).

Source

pub fn backoff_multiplier(self, multiplier: f64) -> RetryPolicy

Set the exponential growth factor.

Source

pub fn jitter(self, jitter: f64) -> RetryPolicy

Set the jitter fraction (clamped to 0.0..=1.0).

Source

pub fn retry_on(self, retry_on: RetryOn) -> RetryPolicy

Set the retryability rule.

Trait Implementations§

Source§

impl Clone for RetryPolicy

Source§

fn clone(&self) -> RetryPolicy

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<(), Error>

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

impl Default for RetryPolicy

Source§

fn default() -> RetryPolicy

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> 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, <T as TryFrom<U>>::Error>

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