Struct Backoff 

pub struct Backoff { /* private fields */ }

Exponential backoff with optional jitter and deadline.

Tracks current delay, retry count, and optional wall-clock deadline. Call .wait(err).await to check exhaustion, sleep if retries remain, and advance state. Returns Err(Exhausted(err)) when done.

Implementations

impl Backoff

pub fn builder() -> BackoffBuilder

Create a builder.

pub async fn wait<E>(&mut self, err: E) -> Result<(), Exhausted<E>>

Check exhaustion, sleep for the current delay, then advance.

Returns Ok(()) if retries remain (caller should loop). Returns Err(Exhausted(err)) if max retries or deadline reached — the caller should escalate or fail over.

If a deadline is set, the sleep is capped to not exceed it.

Panics

Panics if called outside Runtime::block_on.

pub fn advance(&mut self)

Advance the backoff state without sleeping.

Useful when the caller manages timing externally.

pub fn is_exhausted(&self) -> bool

Whether retries are exhausted (max retries or deadline).

Returns false if neither limit is set.

pub fn retries(&self) -> u32

Current retry count.

pub fn current_delay(&self) -> Duration

The next delay (before jitter).

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

Time remaining until deadline, if one is set.

pub fn reset(&mut self)

Reset delay and retry count to initial state.

The deadline is not reset — it is wall-clock absolute.

Trait Implementations

impl Debug for Backoff

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

Formats the value using the given formatter.