FibonacciBuilder

Struct FibonacciBuilder 

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

导出 backon 实现失败重试 FibonacciBuilder is used to build a [FibonacciBackoff] which offers a delay with Fibonacci-based retries.

§Default

  • jitter: false
  • min_delay: 1s
  • max_delay: 60s
  • max_times: 3

§Examples

use anyhow::Result;
use backon::FibonacciBuilder;
use backon::Retryable;

async fn fetch() -> Result<String> {
    Ok(reqwest::get("https://www.rust-lang.org")
        .await?
        .text()
        .await?)
}

#[tokio::main(flavor = "current_thread")]
async fn main() -> Result<()> {
    let content = fetch.retry(FibonacciBuilder::default()).await?;
    println!("fetch succeeded: {}", content);

    Ok(())
}

Implementations§

Source§

impl FibonacciBuilder

Source

pub const fn new() -> FibonacciBuilder

Create a new FibonacciBuilder with default values.

Source

pub const fn with_jitter(self) -> FibonacciBuilder

Set the jitter for the backoff.

When jitter is enabled, FibonacciBackoff will add a random jitter between (0, current_delay) to the delay.

Source

pub fn with_jitter_seed(self, seed: u64) -> FibonacciBuilder

Set the seed value for the jitter random number generator. If no seed is given, a random seed is used in std and default seed is used in no_std.

Source

pub const fn with_min_delay(self, min_delay: Duration) -> FibonacciBuilder

Set the minimum delay for the backoff.

Source

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

Set the maximum delay for the current backoff.

The delay will not increase if the current delay exceeds the maximum delay.

Source

pub const fn without_max_delay(self) -> FibonacciBuilder

Set no maximum delay for the backoff.

The delay will keep increasing.

The delay will saturate at Duration::MAX which is an unrealistic delay.

Source

pub const fn with_max_times(self, max_times: usize) -> FibonacciBuilder

Set the maximum number of attempts for the current backoff.

The backoff will stop if the maximum number of attempts is reached.

Source

pub const fn without_max_times(self) -> FibonacciBuilder

Set no maximum number of attempts for the current backoff.

The backoff will not stop by itself.

The backoff could stop reaching usize::MAX attempts but this is unrealistic.

Trait Implementations§

Source§

impl BackoffBuilder for &FibonacciBuilder

Source§

type Backoff = FibonacciBackoff

The associated backoff returned by this builder.
Source§

fn build(self) -> <&FibonacciBuilder as BackoffBuilder>::Backoff

Construct a new backoff using the builder.
Source§

impl BackoffBuilder for FibonacciBuilder

Source§

type Backoff = FibonacciBackoff

The associated backoff returned by this builder.
Source§

fn build(self) -> <FibonacciBuilder as BackoffBuilder>::Backoff

Construct a new backoff using the builder.
Source§

impl Clone for FibonacciBuilder

Source§

fn clone(&self) -> FibonacciBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FibonacciBuilder

Source§

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

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

impl Default for FibonacciBuilder

Source§

fn default() -> FibonacciBuilder

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

impl Copy for FibonacciBuilder

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
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.
Source§

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

Source§

fn vzip(self) -> V

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

impl<T> ErasedDestructor for T
where T: 'static,