Struct RetryOptions 

pub struct RetryOptions { /* private fields */ }

Immutable retry option snapshot used by crate::Retry.

RetryOptions owns all executor configuration that is independent of the application error type: attempt limits, elapsed budgets, delay strategy, and jitter strategy. Construction validates the delay and jitter values before an executor can use them.

Implementations

impl RetryOptions

pub fn max_attempts(&self) -> u32

Returns maximum attempts, including the initial attempt.

Parameters

This method has no parameters.

Returns

Maximum attempts configured for one retry execution.

Errors

This method does not return errors.

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

Returns maximum cumulative user operation time budget.

Parameters

This method has no parameters.

Returns

Some(Duration) for bounded executions, or None for unlimited.

Errors

This method does not return errors.

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

Returns maximum total retry-flow elapsed time budget.

This budget is measured with monotonic time and includes operation execution, retry sleeps, retry-after sleeps, and retry control-path listener time.

Parameters

This method has no parameters.

Returns

Some(Duration) for bounded executions, or None for unlimited.

Errors

This method does not return errors.

pub fn delay(&self) -> &RetryDelay

Returns the base delay strategy.

Parameters

This method has no parameters.

Returns

Borrowed delay strategy used by the executor.

Errors

This method does not return errors.

pub fn jitter(&self) -> RetryJitter

Returns the jitter strategy.

Parameters

This method has no parameters.

Returns

Jitter strategy used by the executor.

Errors

This method does not return errors.

pub fn attempt_timeout(&self) -> Option<AttemptTimeoutOption>

Returns the optional per-attempt timeout settings.

Parameters

This method has no parameters.

Returns

Some(AttemptTimeoutOption) when per-attempt timeout is configured.

Errors

This method does not return errors.

pub fn worker_cancel_grace(&self) -> Duration

Returns the worker cancellation grace period.

Parameters

This method has no parameters.

Returns

Duration the worker-thread executor waits after requesting cooperative cancellation for a timed-out worker attempt.

pub fn new( max_attempts: u32, max_operation_elapsed: Option<Duration>, max_total_elapsed: Option<Duration>, delay: RetryDelay, jitter: RetryJitter, ) -> Result<RetryOptions, RetryConfigError>

Creates and validates a retry option snapshot.

Parameters

• max_attempts: Maximum number of attempts, including the first call. Must be greater than zero.
• max_operation_elapsed: Optional cumulative user operation time budget for all attempts. Listener execution and retry sleeps are excluded.
• max_total_elapsed: Optional monotonic elapsed-time budget for the whole retry flow. Operation execution, retry sleeps, retry-after sleeps, and retry control-path listener time are included.
• delay: Base delay strategy used between attempts.
• jitter: RetryJitter strategy applied to each base delay.

Returns

A validated RetryOptions value.

Errors

Returns RetryConfigError when max_attempts is zero, or when delay or jitter contains invalid parameters.

pub fn new_with_attempt_timeout( max_attempts: u32, max_operation_elapsed: Option<Duration>, max_total_elapsed: Option<Duration>, delay: RetryDelay, jitter: RetryJitter, attempt_timeout: Option<AttemptTimeoutOption>, ) -> Result<RetryOptions, RetryConfigError>

Creates and validates a retry option snapshot with attempt timeout.

Parameters

• max_attempts: Maximum number of attempts, including the first call. Must be greater than zero.
• max_operation_elapsed: Optional cumulative user operation time budget for all attempts. Listener execution and retry sleeps are excluded.
• max_total_elapsed: Optional monotonic elapsed-time budget for the whole retry flow. Operation execution, retry sleeps, retry-after sleeps, and retry control-path listener time are included.
• delay: Base delay strategy used between attempts.
• jitter: RetryJitter strategy applied to each base delay.
• attempt_timeout: Optional per-attempt timeout settings.

Returns

A validated RetryOptions value.

Errors

Returns RetryConfigError when max_attempts is zero, when delay or jitter contains invalid parameters, or when the attempt timeout is zero.

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

Validates all options.

Returns

Ok(()) when all contained strategy parameters are usable.

Parameters

This method has no parameters.

Errors

Returns RetryConfigError with the relevant config key when the delay or jitter strategy is invalid.

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

Calculates the base retry delay for one failed-attempt index.

Parameters

• attempt: Failed-attempt index, starting at 1.

Returns

Base delay before jitter.

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

Calculates the retry delay for one failed-attempt index after jitter.

Parameters

• attempt: Failed-attempt index, starting at 1.

Returns

Delay after jitter is applied.

pub fn next_base_delay_from_current(&self, current: Duration) -> Duration

Calculates the next base delay from the current base delay.

For exponential delay, this advances by one multiplier step from current and caps at max. For other strategies, this delegates to the strategy’s per-attempt base behavior.

Parameters

• current: Current base delay before jitter.

Returns

Next base delay before jitter.

pub fn jittered_delay(&self, base_delay: Duration) -> Duration

Applies configured jitter to base_delay.

Parameters

• base_delay: Base delay before jitter.

Returns

Delay after jitter.

pub fn next_delay_from_current(&self, current: Duration) -> Duration

Calculates the next delay from the current base delay and applies jitter.

Parameters

• current: Current base delay before jitter.

Returns

Next delay after jitter.

Trait Implementations

impl Clone for RetryOptions

fn clone(&self) -> RetryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryOptions

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

Formats the value using the given formatter.

impl Default for RetryOptions

fn default() -> RetryOptions

Creates the default retry options.

Returns

Options with five attempts, no cumulative user operation time limit, exponential delay, no jitter, and the default worker cancellation grace.

Parameters

This function has no parameters.

Errors

This function does not return errors.

Panics

This function does not panic because the hard-coded attempt count is non-zero.

impl PartialEq for RetryOptions

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