karyon_core::async_util

Struct Backoff

Source
pub struct Backoff {
    base_delay: u64,
    max_delay: u64,
    retries: AtomicU32,
    stop: AtomicBool,
}
Expand description

Exponential backoff https://en.wikipedia.org/wiki/Exponential_backoff

§Examples

use karyon_core::async_util::Backoff;

 async {
    let backoff = Backoff::new(300, 3000);

    loop {
        backoff.sleep().await;
     
        // do something
        break;
    }

    backoff.reset();

    // ....
 };

Fields§

§base_delay: u64

The base delay in milliseconds for the initial retry.

§max_delay: u64

The max delay in milliseconds allowed for a retry.

§retries: AtomicU32

Atomic counter

§stop: AtomicBool

Stop flag

Implementations§

Source§

impl Backoff

Source

pub fn new(base_delay: u64, max_delay: u64) -> Self

Creates a new Backoff.

Source

pub async fn sleep(&self) -> u64

Sleep based on the current retry count and delay values. Retruns the delay value.

Source

pub fn reset(&self)

Reset the retry counter to 0.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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> Same for T

Source§

type Output = T

Should always be Self
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