Struct RetryPolicy 

pub struct RetryPolicy { /* private fields */ }

Overrides Dex retry timing for a Flow, wait_for, or execute operation.

Unset fields use server defaults. Intervals and total duration use Duration; maximum attempts counts the initial attempt. A zero maximum attempts value uses the server behavior.

Step retries default to a one-second initial interval, a multiplier of 2, a 100-second maximum interval, unlimited attempts, and four hours of total duration. Zero values select those defaults. A maximum of one disables retries. Non-retryable handler failures do not retry.

Changed in 1.35.0: a Step’s total duration starts at its first hand-out to a Worker. It only gates scheduling another retry after failure; it never interrupts a running attempt. Method and heartbeat timeouts still apply to that attempt. Initial queue and lock waits do not consume the budget. Later backoff and queue waits do. A scheduled retry can start after the budget expires. Gracefully returning attempt one resets the budget’s start only when no execution of that attempt may have run.

Use this policy for Step methods. The Server does not support whole-Flow retry. It rejects crate::StartFlowOptions::retry_policy with INVALID_ARGUMENT and rejects a SubFlow that sets crate::SubFlowOptions::retry_policy as invalid input. Use Step retry policies instead. Duration values must fit signed 32-bit whole seconds when submitted. Builders take ownership and return the updated policy; validation occurs when the options are mapped for a request.

Examples

use dex_sdk::RetryPolicy;
use std::time::Duration;

let retry = RetryPolicy::new()
    .initial_interval(Duration::from_secs(1))
    .backoff_coefficient(2.0)
    .maximum_interval(Duration::from_secs(30))
    .maximum_attempts(5);

Implementations

impl RetryPolicy

pub fn new() -> Self

Creates an empty policy that preserves every server default.

pub fn initial_interval(self, value: Duration) -> Self

Sets the delay before the first retry.

Zero uses one second. The value must fit signed 32-bit whole seconds.

pub fn backoff_coefficient(self, value: f64) -> Self

Sets the multiplier applied to each successive retry interval.

Zero uses 2. The retry delay grows by this multiplier until the maximum interval.

pub fn maximum_interval(self, value: Duration) -> Self

Caps the delay between retries.

Zero uses 100 seconds. The value must fit signed 32-bit whole seconds.

pub fn maximum_attempts(self, value: u32) -> Self

Sets the total attempt limit, including the initial attempt.

Zero allows unlimited attempts within the total-duration budget for Steps. One disables retries. Values above the signed 32-bit maximum fail when the policy is submitted.

pub fn total_duration(self, value: Duration) -> Self

Sets the elapsed-time budget used to decide whether to retry a failed Step attempt.

For Steps, time starts when Dex first hands the Step to a Worker. Dex checks this budget only after an attempt fails; expiration never ends a running attempt. Unset uses the Server default of four hours. Zero also selects that default. value uses Duration and is serialized in seconds; invalid durations fail when the policy is submitted. Returns this policy with the budget applied.

Changed in 1.35.0: queueing before the first hand-out is excluded, and this budget no longer shortens a running attempt’s method timeout. See RetryPolicy for retry queueing.

use dex_sdk::RetryPolicy;
use std::time::Duration;
let retry = RetryPolicy::new().total_duration(Duration::from_secs(60));

Trait Implementations

impl Clone for RetryPolicy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryPolicy

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

Formats the value using the given formatter.

impl Default for RetryPolicy

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RetryPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RetryPolicy