Struct RetryHeaderOptions 

pub struct RetryHeaderOptions<'a> { /* private fields */ }

Options for reading retry delays from response headers.

Vendor headers are read in order before the standard Retry-After header. By default, each header value is parsed whole. Use RetryHeaderOptions::with_first_field for APIs such as Polar that return comma-separated quota windows and define the first field as the active one.

Parsed delays are uncapped by default, so the classifier reports what the upstream sent. A client that schedules its own retries should set RetryHeaderOptions::with_max_retry_after. Use RetryHeaderOptions::with_forbidden_rate_limit for APIs such as GitHub that also report rate limits with 403.

Implementations

impl<'a> RetryHeaderOptions<'a>

pub const fn new(extra_retry_after_headers: &'a [&'a str]) -> Self

Creates options that consult the named vendor headers in order.

pub const fn with_first_field(self) -> Self

Parses only the first comma-separated field of vendor header values.

This does not split Retry-After, whose HTTP-date form contains a comma.

pub const fn with_max_retry_after(self, max: Duration) -> Self

Clamps parsed delays to max.

An upstream that sends Retry-After: 86400 then yields max instead of stalling a worker for a day.

pub const fn with_forbidden_rate_limit(self) -> Self

Recognizes rate-limit headers on 403 responses.

A usable retry header gives RetryClass::RetryAfter. Otherwise, x-ratelimit-remaining: 0 gives RetryClass::RetryAfter when x-ratelimit-reset is a valid Unix epoch in seconds, or RetryClass::RateLimited without a usable reset. Other 403 responses and all 401 responses stay RetryClass::Revoked.

Trait Implementations

impl<'a> Clone for RetryHeaderOptions<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for RetryHeaderOptions<'a>

impl<'a> Debug for RetryHeaderOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RetryHeaderOptions<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Eq for RetryHeaderOptions<'a>

impl<'a> PartialEq for RetryHeaderOptions<'a>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for RetryHeaderOptions<'a>