Struct condow_rusoto::config::RetryConfig

#[non_exhaustive]
pub struct RetryConfig {
    pub max_attempts: RetryMaxAttempts,
    pub initial_delay_ms: RetryInitialDelayMs,
    pub delay_factor: RetryDelayFactor,
    pub max_delay_ms: RetryDelayMaxMs,
    pub max_stream_resume_attempts: RetryMaxStreamResumeAttempts,
}

Configures retries with exponential backoff

Overview

Retries can be done on the downloads themselves as well on the byte streams returned from a client. If an error occurs while streaming bytes ConDow will try to reconnect with retries and continue streaming where the previous stream failed. Streaming will always be aborted if no bytes were read 3 times in a row even though successful requests for a stream were made.

Retries can also be attempted on size requests.

Be aware that some clients might also do retries themselves based on their underlying implementation. In this case you should disable retries for either the client or ConDow itself.

Limitations

ConDow can only try to resume on byte stream errors if the underlying CondowClient returns an exact bound on the number of bytes returned when a new stream is created.

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.

max_attempts: RetryMaxAttempts

The maximum number of retry attempts.

initial_delay_ms: RetryInitialDelayMs

The delay before the first retry attempt.

delay_factor: RetryDelayFactor

A factor to multiply a current delay with to get the next one

max_delay_ms: RetryDelayMaxMs

The maximum delay for a retry.

max_stream_resume_attempts: RetryMaxStreamResumeAttempts

The maximum number of attempts to resume a byte stream from the same offset.

Setting this to 0 will disable resumes. Enabling them has a small overhead since the current progress on a byte stream must be tracked.

Implementations

impl RetryConfig

pub fn from_env() -> Result<Option<RetryConfig>, Error>

Tries to initialize all fields from environment variables prefixed with “CONDOW_” If no env variables were found None is returned. Otherwise thise found will be set and the rest will be initialized with their defaults.

pub fn from_env_type_names() -> Result<Option<RetryConfig>, Error>

Tries to initialize all fields from environment variables without any prefix If no env variables were found None is returned. Otherwise thise found will be set and the rest will be initialized with their defaults.

pub fn from_env_prefixed<T>(prefix: T) -> Result<Option<RetryConfig>, Error> where
    T: AsRef<str>, 

Tries to initialize all fields from environment variables prefixed with “[prefix]_”

The underscore is omitted if prefix is empty If no env variables were found None is returned. Otherwise thise found will be set and the rest will be initialized with their defaults.

pub fn max_attempts<T>(self, max_attempts: T) -> RetryConfig where
    T: Into<RetryMaxAttempts>, 

Set the maximum number of attempts for retries

pub fn initial_delay_ms<T>(self, initial_delay_ms: T) -> RetryConfig where
    T: Into<RetryInitialDelayMs>, 

Set the delay for the first retry attempt after the original operation failed

pub fn delay_factor<T>(self, delay_factor: T) -> RetryConfig where
    T: Into<RetryDelayFactor>, 

Set the factor by which each current delay will be multiplied by to get the next delay

This is actually what makes it exponentially when greater than 1.0.

pub fn max_delay_ms<T>(self, max_delay_ms: T) -> RetryConfig where
    T: Into<RetryDelayMaxMs>, 

Set the maximum duration in milliseconds for a single delay

pub fn max_stream_resume_attempts<T>(
    self,
    max_stream_resume_attempts: T
) -> RetryConfig where
    T: Into<RetryMaxStreamResumeAttempts>, 

The maximum number of attempts to resume a byte stream from the same offset.

Setting this to 0 will disable resumes. Enabling them has a small overhead since the current progress on a byte stream must be tracked.

pub fn no_stream_resume_attempts(self) -> RetryConfig

Disable attempts to resume a byte stream from the same offset.

pub fn validate(&self) -> Result<(), Error>

Validate this RetryConfig

Succeeds if

• delay_factor is at least 1.0
• delay_factor is a number

pub fn validated(self) -> Result<RetryConfig, Error>

Validate this RetryConfig and return it if it is valid.

Can be used as a finalizer after builder style construction.

See also RetryConfig::validate

Trait Implementations

impl Clone for RetryConfig

fn clone(&self) -> RetryConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetryConfig

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

Formats the value using the given formatter.

impl Default for RetryConfig

fn default() -> RetryConfig

Returns the “default value” for a type.

impl PartialEq<RetryConfig> for RetryConfig

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

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

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

This method tests for !=.

impl StructuralPartialEq for RetryConfig