Struct RetryConfigBuilder

#[non_exhaustive]
pub struct RetryConfigBuilder { /* private fields */ }

Builder for RetryConfig.

Implementations

impl RetryConfigBuilder

pub fn new() -> Self

Creates a new builder.

pub fn set_mode(&mut self, retry_mode: Option<RetryMode>) -> &mut Self

Sets the retry mode.

pub fn mode(self, mode: RetryMode) -> Self

Sets the retry mode.

pub fn reconnect_mode(self, reconnect_mode: ReconnectMode) -> Self

Set the ReconnectMode for the retry strategy

By default, when a transient error is encountered, the connection in use will be poisoned. This prevents reusing a connection to a potentially bad host but may increase the load on the server.

This behavior can be disabled by setting ReconnectMode::ReuseAllConnections instead.

pub fn set_reconnect_mode( &mut self, reconnect_mode: Option<ReconnectMode>, ) -> &mut Self

Set the ReconnectMode for the retry strategy

By default, when a transient error is encountered, the connection in use will be poisoned. This prevents reusing a connection to a potentially bad host but may increase the load on the server.

This behavior can be disabled by setting ReconnectMode::ReuseAllConnections instead.

pub fn set_max_attempts(&mut self, max_attempts: Option<u32>) -> &mut Self

Sets the max attempts. This value must be greater than zero.

pub fn max_attempts(self, max_attempts: u32) -> Self

Sets the max attempts. This value must be greater than zero.

pub fn set_initial_backoff( &mut self, initial_backoff: Option<Duration>, ) -> &mut Self

Set the initial_backoff duration. This duration should be non-zero.

pub fn initial_backoff(self, initial_backoff: Duration) -> Self

Set the initial_backoff duration. This duration should be non-zero.

pub fn set_max_backoff(&mut self, max_backoff: Option<Duration>) -> &mut Self

Set the max_backoff duration. This duration should be non-zero.

pub fn max_backoff(self, max_backoff: Duration) -> Self

Set the max_backoff duration. This duration should be non-zero.

pub fn take_unset_from(self, other: Self) -> Self

Merge two builders together. Values from other will only be used as a fallback for values from self Useful for merging configs from different sources together when you want to handle “precedence” per value instead of at the config level

Example

let a = RetryConfigBuilder::new().max_attempts(1);
let b = RetryConfigBuilder::new().max_attempts(5).mode(RetryMode::Adaptive);
let retry_config = a.take_unset_from(b).build();
// A's value take precedence over B's value
assert_eq!(retry_config.max_attempts(), 1);
// A never set a retry mode so B's value was used
assert_eq!(retry_config.mode(), RetryMode::Adaptive);

pub fn build(self) -> RetryConfig

Builds a RetryConfig.

Trait Implementations

impl Clone for RetryConfigBuilder

fn clone(&self) -> RetryConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetryConfigBuilder

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

Formats the value using the given formatter.

impl Default for RetryConfigBuilder

fn default() -> RetryConfigBuilder

Returns the “default value” for a type.

impl PartialEq for RetryConfigBuilder

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