# ratelimit - a token bucket ratelimiter for rust
ratelimit provides a token bucket ratelimiter which can be used by a single thread, or shared across threads by using a channel to push tokens to the ratelimiter
[](https://travis-ci.org/brayniac/ratelimit)
[](https://crates.io/crates/ratelimit)
[](http://doge.mit-license.org)
## Usage
To use `ratelimit`, first add this to your `Cargo.toml`:
```toml
[dependencies]
ratelimit = "*"
```
Then, add this to your crate root:
```rust
extern crate ratelimit;
```
## Documentation
View the docs here: [http://brayniac.github.io/ratelimit/](http://brayniac.github.io/ratelimit/)
## Features
* token bucket ratelimiter
* single or multi threaded uses
## Future work
* additional ratelimiter models
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.