Skip to main content

RetryPolicy

Enum RetryPolicy 

Source
pub enum RetryPolicy {
    Count {
        attempts: u32,
        should_retry: Option<ShouldRetryFn>,
    },
    Linear {
        attempts: u32,
        delay: Duration,
        should_retry: Option<ShouldRetryFn>,
        jitter: bool,
    },
    Exponential {
        attempts: u32,
        base_delay: Duration,
        max_delay: Duration,
        should_retry: Option<ShouldRetryFn>,
        jitter: bool,
    },
}
Expand description

Retry policy configuration.

The attempts value is the maximum number of retries after the initial request. For example, RetryPolicy::count(2) performs up to three HTTP calls (one initial + two retries).

§Examples

use better_fetch::RetryPolicy;

// Up to 3 HTTP calls total (1 initial + 2 retries), 1s between attempts
let policy = RetryPolicy::count(2);
assert_eq!(policy.max_attempts(), 2);

Variants§

§

Count

Shorthand for linear retry with attempts retries and a 1 second delay between attempts.

Fields

§attempts: u32

Maximum retries after the first request.

§should_retry: Option<ShouldRetryFn>

Optional custom retry predicate.

§

Linear

Fixed delay between retries.

Fields

§attempts: u32

Maximum retries after the first request.

§delay: Duration

Delay between attempts.

§should_retry: Option<ShouldRetryFn>
§jitter: bool

When true, randomizes delay (see Self::with_jitter).

§

Exponential

Exponential backoff capped at max_delay.

Fields

§attempts: u32

Maximum retries after the first request.

§base_delay: Duration

Initial backoff duration.

§max_delay: Duration

Upper bound on backoff.

§should_retry: Option<ShouldRetryFn>
§jitter: bool

Implementations§

Source§

impl RetryPolicy

Source

pub fn count(attempts: u32) -> Self

Shorthand: attempts retries with a fixed 1 second delay and default status codes.

Count does not apply jitter. For randomized backoff use Self::exponential (jitter on by default) or Self::linear with Self::with_jitter(true).

Source

pub fn linear(attempts: u32, delay: Duration) -> Self

Linear backoff with a fixed delay between retries.

Source

pub fn exponential( attempts: u32, base_delay: Duration, max_delay: Duration, ) -> Self

Exponential backoff from base_delay up to max_delay (jitter enabled by default).

Source

pub fn with_jitter(self, jitter: bool) -> Self

Enables randomized backoff jitter on linear or exponential policies.

No effect on RetryPolicy::Count — use Self::exponential for jittered delays.

Source

pub fn with_should_retry(self, f: ShouldRetryFn) -> Self

Overrides the default retry predicate (408, 429, 502, 503, 504).

Source

pub fn max_attempts(&self) -> u32

Returns the maximum number of retries after the initial request.

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

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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: 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: 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 = Infallible

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,