Struct RetryInfo

pub struct RetryInfo {
    pub retry_delay: Option<Duration>,
}

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

retry_delay: Option<Duration>

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

Implementations

impl RetryInfo

pub const fn const_default() -> RetryInfo

pub fn retry_delay_opt_mut(&mut self) -> Option<&mut Duration>

If retry_delay is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn retry_delay_mut(&mut self) -> &mut Duration

Returns a mutable reference to retry_delay. If the field is unset, it is first initialized with the default value.

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

If retry_delay is set, returns Some with the value; otherwise returns None.

pub fn set_retry_delay<T>(&mut self, field: T)

where T: Into<Duration>,

Sets retry_delay with the provided value.

pub fn with_retry_delay<T>(self, field: T) -> RetryInfo

where T: Into<Duration>,

Sets retry_delay with the provided value.

Trait Implementations

impl Clone for RetryInfo

fn clone(&self) -> RetryInfo

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for RetryInfo

fn default() -> RetryInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RetryInfo

fn deserialize<D>( deserializer: D, ) -> Result<RetryInfo, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RetryInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for RetryInfo

const NAME: &'static str = "RetryInfo"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "google.rpc"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

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 Serialize for RetryInfo

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RetryInfo

impl StructuralPartialEq for RetryInfo