Struct RetryInfo

#[non_exhaustive]
pub struct RetryInfo {
    pub retry_delay: Option<Duration>,
    /* private fields */
}

Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.

It’s always recommended that clients should use exponential backoff when retrying.

Clients should wait until retry_delay amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on retry_delay, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

retry_delay: Option<Duration>

Clients should wait at least this long between retrying the same request.

Implementations

impl RetryInfo

pub fn new() -> Self

pub fn set_retry_delay<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of retry_delay.

pub fn set_or_clear_retry_delay<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of retry_delay.

Trait Implementations

impl Clone for RetryInfo

fn clone(&self) -> RetryInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryInfo

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

Formats the value using the given formatter.

impl Default for RetryInfo

fn default() -> RetryInfo

Returns the “default value” for a type.

impl Message for RetryInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RetryInfo

fn eq(&self, other: &RetryInfo) -> 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 StructuralPartialEq for RetryInfo