Skip to main content

Backoff

Enum Backoff 

Source
pub enum Backoff {
    None,
    Constant(Duration),
    Sequence(Vec<Duration>),
    Exponential {
        initial: Duration,
        multiplier: f64,
        max: Duration,
    },
}
Expand description

Built-in delay calculation between attempts. The initial attempt has no delay.

Variants§

§

None

Retry immediately, while still respecting cancellation and deadlines.

§

Constant(Duration)

Use one fixed delay for every retry.

§

Sequence(Vec<Duration>)

Exactly one delay for each retry; the schedule validates its length.

§

Exponential

Multiply initial by multiplier for each retry, bounded by max.

Fields

§initial: Duration
§multiplier: f64

Implementations§

Source§

impl Backoff

Source

pub fn constant(delay: Duration) -> Self

Construct a fixed delay.

Source

pub fn sequence(delays: impl IntoIterator<Item = Duration>) -> Self

Construct an explicit delay sequence. Validation occurs when building a schedule.

Source

pub fn exponential(initial: Duration, multiplier: f64, max: Duration) -> Self

Construct an exponential delay. The multiplier must be finite and at least one.

Source

pub fn delay_for( &self, retry_ordinal: u32, ) -> Result<Duration, RetryConfigError>

Calculate a one-based retry delay without jitter.

Ordinal one is the delay before attempt two. Zero and sequence indices outside the configured sequence are errors, rather than implicit repeats.

Trait Implementations§

Source§

impl Clone for Backoff

Source§

fn clone(&self) -> Self

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 Backoff

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Backoff

Source§

fn default() -> Self

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

impl PartialEq for Backoff

Source§

fn eq(&self, other: &Self) -> 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 Backoff

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

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