Struct RetryPolicy 

pub struct RetryPolicy {
    pub max_retries: u32,
    pub initial_delay: Duration,
    pub max_delay: Duration,
    pub backoff_multiplier: f64,
    pub use_jitter: bool,
}

Retry policy for transient errors.

Controls exponential backoff retry behavior.

See docs/spec/interfaces/rate-limiting-retry.md

Fields

max_retries: u32

Maximum number of retry attempts

initial_delay: Duration

Initial delay before first retry

max_delay: Duration

Maximum delay between retries

backoff_multiplier: f64

Backoff multiplier (e.g., 2.0 for doubling)

use_jitter: bool

Whether to add jitter to delays

Implementations

impl RetryPolicy

pub fn new( max_retries: u32, initial_delay: Duration, max_delay: Duration, ) -> Self

Create a new retry policy with custom settings.

pub fn with_jitter(self) -> Self

Enable jitter (random variation) in retry delays.

Jitter helps prevent thundering herd problems when multiple clients retry simultaneously. Adds ±25% randomization to calculated delays.

Examples

use github_bot_sdk::client::RetryPolicy;

let policy = RetryPolicy::default().with_jitter();

pub fn without_jitter(self) -> Self

Disable jitter (no random variation) in retry delays.

Use this for deterministic testing or when precise timing is required.

Examples

use github_bot_sdk::client::RetryPolicy;

let policy = RetryPolicy::default().without_jitter();

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

Calculate delay for a specific retry attempt.

Uses exponential backoff with optional jitter.

Jitter

When jitter is enabled (default), applies ±25% randomization to prevent thundering herd problems. For example, a 1000ms delay becomes 750-1250ms.

Examples

use github_bot_sdk::client::RetryPolicy;

let policy = RetryPolicy::default();
let delay = policy.calculate_delay(1);
// First retry: ~100ms ±25%

See docs/spec/interfaces/rate-limiting-retry.md

pub fn should_retry(&self, attempt: u32) -> bool

Check if another retry attempt should be made.

Arguments

• attempt - Current attempt number (0-indexed)

Returns

true if attempt is below max_retries, false otherwise.

Trait Implementations

impl Clone for RetryPolicy

fn clone(&self) -> RetryPolicy

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<'de> Deserialize<'de> for RetryPolicy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RetryPolicy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.