Struct ReconnectOptions

Source
pub struct ReconnectOptions {
    pub max_attempts: Option<u32>,
    pub initial_delay: Duration,
    pub max_delay: Duration,
    pub backoff_multiplier: f64,
    pub use_exponential_backoff: bool,
}
Expand description

Options for automatic reconnection.

Fields§

§max_attempts: Option<u32>

Maximum number of reconnection attempts (None = unlimited).

§initial_delay: Duration

Initial delay before first reconnection attempt.

§max_delay: Duration

Maximum delay between attempts (for exponential backoff).

§backoff_multiplier: f64

Multiplier for exponential backoff.

§use_exponential_backoff: bool

Whether to use exponential backoff.

Implementations§

Source§

impl ReconnectOptions

Source

pub fn new() -> Self

Create new reconnect options with defaults.

Source

pub fn unlimited() -> Self

Create options with unlimited retry attempts.

Source

pub fn fixed_delay(delay: Duration) -> Self

Create options with a fixed delay (no backoff).

Source

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

Set maximum number of reconnection attempts.

Source

pub fn initial_delay(self, delay: Duration) -> Self

Set initial delay before first reconnection attempt.

Source

pub fn max_delay(self, delay: Duration) -> Self

Set maximum delay between attempts.

Source

pub fn backoff_multiplier(self, multiplier: f64) -> Self

Set backoff multiplier for exponential backoff.

Source

pub fn exponential_backoff(self, enabled: bool) -> Self

Enable or disable exponential backoff.

Source

pub fn delay_for_attempt(&self, attempt: u32) -> Duration

Calculate delay for a given attempt number.

Source

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

Validate the options and return an error if invalid.

Checks that:

  • backoff_multiplier is >= 1.0
  • initial_delay is > 0
  • max_delay >= initial_delay

Trait Implementations§

Source§

impl Clone for ReconnectOptions

Source§

fn clone(&self) -> ReconnectOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReconnectOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ReconnectOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more