Enum RetryJitter

Source

pub enum RetryJitter {
    None,
    Factor(f64),
}

Expand description

Jitter strategy applied after a base crate::RetryDelay has been calculated.

Supports RetryJitter::None and symmetric RetryJitter::Factor jitter. After randomization, delays are clamped to non-negative values.

Variants§

§

None

No jitter: RetryJitter::apply returns the base delay unchanged.

§

Factor(f64)

Symmetric relative jitter around the base delay.

The inner f64 is the relative half-span: jitter is drawn uniformly from [-base * factor, base * factor] nanoseconds (see RetryJitter::apply). It must be finite and lie in [0.0, 1.0] for validated configurations.

Implementations§

Source §

impl RetryJitter

Source

pub fn none() -> RetryJitter

Creates a no-jitter strategy.

§Parameters

This function has no parameters.

§Returns

A RetryJitter::None strategy.

§Errors

This function does not return errors.

Source

pub fn factor(factor: f64) -> RetryJitter

Creates a symmetric relative jitter strategy.

Validation requires factor to be finite and within [0.0, 1.0].

§Parameters

factor: Relative jitter range. For example, 0.2 samples from base +/- 20%.

§Returns

A RetryJitter::Factor strategy.

§Errors

This constructor does not validate factor; use RetryJitter::validate before applying values that come from configuration or user input.

Source

pub fn apply(&self, base: Duration) -> Duration

Applies jitter to a base delay.

For RetryJitter::None, returns base unchanged.

For RetryJitter::Factor, if factor <= 0.0 or base is zero, returns base unchanged. Otherwise draws a uniform sample from the inclusive range [-base * factor, base * factor] in nanosecond space, adds it to the base, then clamps the result to at least zero (truncating the sum to u64 nanoseconds). When base exceeds u64::MAX nanoseconds, this function returns base unchanged to avoid lossy downcasts.

§Parameters

base: Base delay calculated by crate::RetryDelay.

§Returns

The jittered delay, never below zero.

§Errors

This function does not return errors.

§Panics

This function does not panic for non-finite factors. Non-finite values gracefully fall back to returning base.

Source

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

Calculates and jitters the delay for one retry attempt.

This method combines base-delay strategy selection and jitter application into one step.

§Parameters

delay_strategy: Base delay strategy used to calculate the attempt delay.
attempt: Failed-attempt index passed to RetryDelay::base_delay.

§Returns

The delay for the attempt after jitter is applied.

§Errors

This function does not return errors.

§Panics

This function does not panic for non-finite factors. Non-finite values gracefully fall back to returning the base delay.

Source

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

Validates jitter parameters for use with executors and options.

RetryJitter::None is always valid. For RetryJitter::Factor, the factor must be finite and satisfy 0.0 <= factor <= 1.0 (endpoints included).