Struct Builder

pub struct Builder<C: Clock> { /* private fields */ }

Builder for Limiter.

Examples

use async_speed_limit::Limiter;
use std::time::Duration;

let limiter = <Limiter>::builder(1_048_576.0)
    .refill(Duration::from_millis(100))
    .build();

Implementations

impl<C: Clock> Builder<C>

pub fn new(speed_limit: f64) -> Self

Creates a new limiter builder.

Use infinity to make the speed unlimited.

pub fn speed_limit(&mut self, speed_limit: f64) -> &mut Self

Sets the speed limit of the limiter.

Use infinity to make the speed unlimited.

Panics

The speed limit must be positive. Panics if the speed limit is negative, zero, or NaN.

pub fn refill(&mut self, dur: Duration) -> &mut Self

Sets the refill period of the limiter.

The default value is 0.1 s, which should be good for most use cases. The refill period is ignored if the speed is infinity.

Panics

The duration must not be zero, otherwise this method panics.

pub fn min_wait(&mut self, dur: Duration) -> &mut Self

Sets the minimum wait duration when the speed limit was exceeded.

The default value is same as the refill period.

pub fn clock(&mut self, clock: C) -> &mut Self

Sets the clock instance used by the limiter.

pub fn build(&mut self) -> Limiter<C>

Builds the limiter.

Trait Implementations

impl<C: Debug + Clock> Debug for Builder<C>

where C::Instant: Debug,

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

Formats the value using the given formatter.