Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
pub struct RetryPolicy { /* private fields */ }
Expand description

Decides how often a failed delivery is retried and how long its subscription waits between attempts. A delivery keeps its subscription’s concurrency slot while it waits, so a subscription handling one message at a time retries it before moving on to the next. Delays that would overflow saturate at Duration::MAX, use with_max_delay to cap them.

§Example
use std::time::Duration;
use topmesys::RetryPolicy;

let policy = RetryPolicy::exponential(4, Duration::from_millis(100))
    .with_max_delay(Duration::from_millis(500));

assert_eq!(policy.delay(1), Duration::from_millis(100));
assert_eq!(policy.delay(3), Duration::from_millis(400));
assert_eq!(policy.delay(4), Duration::from_millis(500));

Implementations§

Source§

impl RetryPolicy

Source

pub fn new(retries: u32, backoff: Backoff) -> Self

Retries a failed delivery up to retries times, waiting according to backoff.

Source

pub fn none() -> Self

Never retries: a failed delivery is dead-lettered right away.

Source

pub fn fixed(retries: u32, delay: Duration) -> Self

Source

pub fn linear(retries: u32, initial: Duration, increment: Duration) -> Self

Source

pub fn exponential(retries: u32, initial: Duration) -> Self

Doubles the delay with every retry, starting at initial.

Source

pub fn with_max_delay(self, max_delay: Duration) -> Self

Caps every delay at max_delay.

Source

pub fn with_jitter(self) -> Self

Randomises every delay to between half and all of its computed value, so deliveries that failed together don’t retry at the same moment.

Source

pub fn retries(&self) -> u32

Source

pub fn delay(&self, retry: u32) -> Duration

The delay before the given retry, counting from 1. Jitter is not applied.

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
Source§

impl Default for RetryPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for RetryPolicy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RetryPolicy

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
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.

Source§

impl<T> Instrument for T

Source§

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

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

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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