Struct ratelimit::Limiter

pub struct Limiter { /* private fields */ }

Single-threaded rate limiter.

Implementations

impl Limiter

pub fn new() -> Limiter

create a new default ratelimit instance

Example

let mut r = Limiter::new();

pub fn configure() -> Builder

create a new Config for building a custom Limiter

Example

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

pub fn run(&mut self)

Run the limiter, intended for multi-threaded use

Example

let mut limiter = Limiter::new();

let mut handle = limiter.make_handle();

thread::spawn(move || { limiter.run(); });

handle.wait();

pub fn make_handle(&mut self) -> Handle

Create a Handle for multi-thread use

Example

let mut limiter = Limiter::new();

let mut handle = limiter.make_handle();

match handle.try_wait() {
    Ok(_) => {
        println!("not limited");
    },
    Err(_) => {
        println!("was limited");
    },
}

pub fn wait(&mut self)

Blocking wait for 1 token.

Example

let mut limiter = Limiter::new();
for i in -10..0 {
    println!("T {}...", i);
    limiter.wait();
}
println!("Ignition!");

pub fn try_wait(&mut self) -> Result<(), ()>

Non-blocking wait for one token. Returns Ok(()) if no wait required. Returns Err(()) if wait would block.

Examples

let mut limiter = Limiter::new();

if limiter.try_wait().is_ok() {
    println!("token granted");
} else {
    println!("would block");
}

pub fn wait_for(&mut self, count: usize)

Blocking wait for count tokens.

Example

let mut limiter = Limiter::new();
for i in 1..3 {
    println!("{}...", i);
    limiter.wait_for(i);
}

pub fn try_wait_for(&mut self, count: usize) -> Result<(), ()>

Returns Ok(()) if no wait required. Returns Err(()) if wait would block.

Examples

let mut limiter = Limiter::new();

if limiter.try_wait_for(2).is_ok() {
    println!("tokens granted");
} else {
    println!("would block");
}

Trait Implementations

impl Default for Limiter

fn default() -> Limiter

Returns the “default value” for a type.