Struct Bucket 

pub struct Bucket { /* private fields */ }

This is the main struct to do everything you need

Global or task-based

Essentially buckets just store usages and limits, meaning you can create a different bucket for each kind of limit: each of your commands, separate buckets for channel and user usage if you want to have different limits for each etc.

Usage

Register usages using the Bucket::register method after getting the limit with Bucket::limit_duration

IDs use NonZeroU64 to be compatible with any kind of ID: users, guilds or even your custom IDs

Implementations

impl Bucket

pub fn new(limit: Limit) -> Self

Create a new Bucket with the given limit

pub fn register(&self, id: u64)

Register a usage, you should call this every time something you want to limit is done after waiting for the limit

if let Some(duration) = bucket.limit_duration(user_id) {
    tokio::time::sleep(duration).await;
}
bucket.register(user_id);

Panics

If the id is 0 or when the usage count is over u16::MAX

pub fn limit_duration(&self, id: u64) -> Option<Duration>

Get the duration to wait until the next usage by id, returns None if the id isn’t limited, you should call this before registering a usage

if let Some(duration) = bucket.limit_duration(user_id) {
    tokio::time::sleep(duration).await;
}
bucket.register(user_id);

Panics

If the id is 0

Trait Implementations

impl Debug for Bucket

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

Formats the value using the given formatter.