Struct slottle::ThrottlePoolBuilder

pub struct ThrottlePoolBuilder<K: Hash + Eq> { /* fields omitted */ }

Use to build a ThrottlePool.

Created by ThrottlePool::builder() API.

Implementations

impl<K: Hash + Eq> ThrottlePoolBuilder<K>

pub fn interval<I>(&mut self, interval: I) -> &mut Self where
    I: Into<Interval>, 

Set interval of throttles in this pool.

The default value is no delay (Duration::new(0, 0))

Example

use slottle::{ThrottlePool, Interval};
use std::time::Duration;
use rand;

// fixed interval: 10ms
let pool: ThrottlePool<bool> = ThrottlePool::builder()
    .interval(Duration::from_millis(10))
    .build().unwrap();

// random interval between: 10ms ~ 0ms
let pool: ThrottlePool<bool> = ThrottlePool::builder()
    .interval(|| Duration::from_millis(10).mul_f64(rand::random()))
    .build().unwrap();

// increasing delay if failed continuously
let pool: ThrottlePool<bool> = ThrottlePool::builder()
    .interval(Interval::new(
        |log| match log.unwrap().failure_count_cont() {
            0 => Duration::from_millis(10),
            1 => Duration::from_millis(30),
            2 => Duration::from_millis(50),
            3 => Duration::from_millis(70),
            _ => unreachable!(),
        },
        3,  // maximum log size
    ))
    .build().unwrap();

// use pre-defined interval algorithm
let pool: ThrottlePool<bool> = ThrottlePool::builder()
    .interval(slottle::fibonacci(
        Duration::from_millis(10),
        Duration::from_secs(2),
    ))
    .build().unwrap();

pub fn concurrent(&mut self, concurrent: u32) -> &mut Self

Set concurrent, default value is 1.

pub fn build(&self) -> Option<ThrottlePool<K>>

Create a new ThrottlePool with current configuration.

Return None if concurrent == 0 or larger than isize::MAX.

Trait Implementations

impl<K: Hash + Eq> Debug for ThrottlePoolBuilder<K>

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

Formats the value using the given formatter.

impl<K: Hash + Eq> Default for ThrottlePoolBuilder<K>

fn default() -> Self

Returns the “default value” for a type.