Struct ratelimit::Builder

pub struct Builder { /* private fields */ }

A builder for a rate limiter.

Implementations

impl Builder

pub fn new() -> Builder

Creates a new Builder with the default config

Examples

let mut b = Builder::new();

pub fn build(self) -> Limiter

Returns a Limiter from the Builder.

Example

let mut r = Builder::new().build();

pub fn quantum(self, quantum: u32) -> Self

Sets the number of tokens to add per interval.

Examples

let mut r = Limiter::configure()
    .quantum(100)
    .build();

pub fn capacity(self, capacity: u32) -> Self

Sets the number of tokens that the bucket can hold.

Examples

let mut r = Limiter::configure()
    .capacity(100)
    .build();

pub fn interval(self, interval: Duration) -> Self

Set the duration between token adds.

Examples

let mut r = Limiter::configure()
    .interval(Duration::new(2, 0))
    .build();

pub fn frequency(self, cycles: u32) -> Self

Alternative to interval; sets the number of times that tokens will be added to the bucket each second.

Examples

let mut rate = 100_000; // 100kHz
let mut r = Limiter::configure()
    .frequency(rate)
    .build();

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.