Struct RetryAfter

pub struct RetryAfter { /* private fields */ }

Indicate how long the user agent should wait before making a follow-up request.

MDN Documentation

Specifications

• RFC 7231, section 3.1.4.2: Retry-After

Examples

use http_types::other::RetryAfter;
use http_types::Response;
use std::time::{SystemTime, Duration};
use async_std::task;

let retry = RetryAfter::new(Duration::from_secs(10));

let mut headers = Response::new(429);
retry.apply(&mut headers);

// Sleep for the duration, then try the task again.
let retry = RetryAfter::from_headers(headers)?.unwrap();
task::sleep(retry.duration_since(SystemTime::now())?);

Implementations

impl RetryAfter

pub fn new(dur: Duration) -> Self

Create a new instance from a Duration.

This value will be encoded over the wire as a relative offset in seconds.

pub fn new_at(at: SystemTime) -> Self

Create a new instance from a SystemTime instant.

This value will be encoded a specific Date over the wire.

pub fn from_headers(headers: impl AsRef<Headers>) -> Result<Option<Self>>

Create a new instance from headers.

pub fn duration_since( &self, earlier: SystemTime, ) -> Result<Duration, SystemTimeError>

Returns the amount of time elapsed from an earlier point in time.

Errors

This may return an error if the earlier time was after the current time.

pub fn apply(&self, headers: impl AsMut<Headers>)

Sets the header.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

Trait Implementations

impl Clone for RetryAfter

fn clone(&self) -> RetryAfter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetryAfter

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

Formats the value using the given formatter.

impl From<RetryAfter> for SystemTime

fn from(retry_after: RetryAfter) -> Self

Converts to this type from the input type.

impl Hash for RetryAfter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RetryAfter

fn cmp(&self, other: &RetryAfter) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RetryAfter

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RetryAfter

fn partial_cmp(&self, other: &RetryAfter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RetryAfter

impl StructuralPartialEq for RetryAfter