Struct http_types::other::RetryAfter

pub struct RetryAfter { /* fields omitted */ }

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

pub fn clone(&self) -> RetryAfter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetryAfter

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

Formats the value using the given formatter.

impl Eq for RetryAfter

impl Hash for RetryAfter

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for RetryAfter

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RetryAfter> for RetryAfter

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<RetryAfter> for RetryAfter

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for RetryAfter

impl StructuralPartialEq for RetryAfter