Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
pub struct RetryPolicy {
    pub max_attempts: usize,
    pub strategy: RetryStrategy,
}
Expand description

Configuration for automatic retry behaviour with backoff.

Construct via the factory helpers RetryPolicy::fixed, RetryPolicy::exponential, or RetryPolicy::linear, then execute an async closure with RetryPolicy::retry.

§Examples

use std::time::Duration;
use tokio_prompt_orchestrator::enhanced::RetryPolicy;

let policy = RetryPolicy::exponential(3, Duration::from_millis(100));

let result: Result<String, String> = policy.retry(|| async {
    // replace with a real async call
    Err("transient".to_string())
}).await;

// All 3 attempts failed
assert!(result.is_err());

Fields§

§max_attempts: usize

Maximum number of attempts (including the first try).

§strategy: RetryStrategy

Backoff strategy applied between consecutive attempts.

Implementations§

Source§

impl RetryPolicy

Source

pub fn fixed(max_attempts: usize, delay: Duration) -> Self

Create a policy that waits a constant delay between attempts.

§Arguments
  • max_attempts — Total attempts including the first try. 1 means no retries.
  • delay — Fixed pause between consecutive attempts.
§Examples
use std::time::Duration;
use tokio_prompt_orchestrator::enhanced::RetryPolicy;

let policy = RetryPolicy::fixed(3, Duration::from_millis(50));
assert_eq!(policy.max_attempts, 3);
Source

pub fn exponential(max_attempts: usize, initial_delay: Duration) -> Self

Create a policy with exponential back-off (multiplier 2×, cap 60 s).

The delay before attempt n is: min(initial_delay × 2^(n-1), 60 s)

§Arguments
  • max_attempts — Total attempts including the first try.
  • initial_delay — Delay before the second attempt.
§Examples
use std::time::Duration;
use tokio_prompt_orchestrator::enhanced::RetryPolicy;

// Delays: 100 ms, 200 ms, 400 ms
let policy = RetryPolicy::exponential(4, Duration::from_millis(100));
Source

pub fn linear( max_attempts: usize, initial_delay: Duration, increment: Duration, ) -> Self

Create policy with linear backoff

Source

pub async fn retry<F, Fut, T, E>(&self, f: F) -> Result<T, E>
where F: FnMut() -> Fut, Fut: Future<Output = Result<T, E>>, E: Display,

Execute a fallible async closure, retrying on error according to this policy.

The closure f is called up to max_attempts times. Between consecutive failures the task sleeps for the duration computed by the configured RetryStrategy.

§Arguments
  • f — A FnMut that returns a Future<Output = Result<T, E>>.
§Returns

Ok(value) from the first successful attempt, or Err(last_error) if all attempts fail.

§Examples
use std::time::Duration;
use tokio_prompt_orchestrator::enhanced::RetryPolicy;

let policy = RetryPolicy::fixed(3, Duration::from_millis(10));
let result: Result<&str, &str> = policy.retry(|| async { Ok("done") }).await;
assert_eq!(result, Ok("done"));
Source

pub async fn retry_with_details<F, Fut, T, E>(&self, f: F) -> RetryResult<T, E>
where F: FnMut() -> Fut, Fut: Future<Output = Result<T, E>>, E: Display,

Execute with retries, returning detailed result

Source

pub fn is_retryable<E>(&self, _error: &E) -> bool

Check if error is retryable (can be customized)

Trait Implementations§

Source§

impl Clone for RetryPolicy

Source§

fn clone(&self) -> RetryPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RetryPolicy

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more