Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
pub struct RetryPolicy { /* private fields */ }
Expand description

Policy-driven retry configuration.

Controls which requests are retried, how many times, and with what backoff strategy. Retries are opt-in: the default policy disables retries.

§Examples

use std::time::Duration;
use eggfetch_core::RetryPolicy;

let policy = RetryPolicy::builder()
    .max_attempts(3)
    .backoff_factor(0.2)
    .retry_status(429)
    .retry_status(503)
    .build();

Implementations§

Source§

impl RetryPolicy

Source

pub fn builder() -> RetryPolicyBuilder

Create a new retry policy builder.

Source

pub fn max_attempts(&self) -> usize

Returns the maximum number of total attempts.

Source

pub fn max_elapsed(&self) -> Option<Duration>

Returns the maximum total elapsed time.

Source

pub fn backoff(&self) -> &BackoffPolicy

Returns a reference to the backoff policy.

Source

pub fn method_policy(&self) -> &MethodPolicy

Returns a reference to the method policy.

Source

pub fn status_policy(&self) -> &StatusPolicy

Returns a reference to the status policy.

Source

pub fn respect_retry_after(&self) -> bool

Returns whether Retry-After headers are respected.

Source

pub fn is_enabled(&self) -> bool

Returns true if retries are effectively enabled (max_attempts > 1).

Source

pub fn is_method_retryable(&self, method: &Method) -> bool

Returns true if the given method is eligible for retry.

Source

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

Returns true if the given status code is eligible for retry.

Source

pub fn is_error_retryable(error: &Error) -> bool

Returns true if the given error is eligible for retry.

Source

pub fn backoff_delay(&self, attempt: usize) -> Option<Duration>

Compute the backoff delay for the given attempt number (1-indexed).

Returns None if no delay is needed (attempt 1).

Source

pub fn retry_after_delay(&self, retry_after: &str) -> Option<Duration>

Compute the delay after receiving a Retry-After header value.

Parses Retry-After as either a number of seconds or an HTTP-date. Returns None if parsing fails, if a past HTTP-date is supplied (the header carries no useful information), or if the value exceeds the backoff cap.

Source

pub fn check_body_replayable(body: &RequestBody) -> ReplayCheck

Check if a request body is replayable for retry.

Returns ReplayCheck::Replayable if the body can be replayed, or ReplayCheck::NotReplayable if the body is a live stream.

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

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