Struct ratelimit::Handle

pub struct Handle { /* fields omitted */ }

Handler for a multi-threaded rate-limiter.

Methods

impl Handle

fn wait(&mut self)

Block for 1 token

Examples

let mut limiter = Builder::default().build();
let mut handle = limiter.make_handle();

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

let mut threads = Vec::new();

for i in 0..2 {
    let mut handle = handle.clone();
    threads.push(thread::spawn(move || {
        for x in 0..5 {
            handle.wait();
            println!(".");
        }
    }));
}

fn wait_for(&mut self, count: usize)

Block for count tokens

Examples

let mut limiter = Builder::default().build();
let mut handle = limiter.make_handle();

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

let mut threads = Vec::new();

for i in 0..2 {
    let mut handle = handle.clone();
    threads.push(thread::spawn(move || {
        for x in 0..5 {
            handle.wait_for(1);
            println!(".");
        }
    }));
}

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 = Builder::new().build();
let mut handle = limiter.make_handle();

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

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

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

Examples

let mut limiter = Builder::new().build();
let mut handle = limiter.make_handle();

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

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Sync for Handle