Struct twitchchat::rate_limit::RateLimit

pub struct RateLimit { /* fields omitted */ }

A leaky-bucket style token-based rate limiter

Implementations

impl RateLimit

pub fn set_cap(&mut self, cap: u64)

Overwrite the current capacity with this value

pub fn set_period(&mut self, period: Duration)

Overwrite the current period with this value

pub fn get_cap(&self) -> u64

Get the current capacity with this value

pub fn get_period(&self) -> Duration

Get the current period with this value

pub fn from_class(rate_class: RateClass) -> Self

Create a rate limit from a RateClass

pub fn new(cap: u64, initial: u64, period: Duration) -> Self

Create a new rate limiter of capacity with an initial number of token and the period between refills

pub fn full(cap: u64, period: Duration) -> Self

Create a new rate limiter that is pre-filled

cap is the number of total tokens available

period is how long it'll take to refill all of the tokens

pub fn empty(cap: u64, period: Duration) -> Self

Create am empty rate limiter

cap is the number of total tokens available

period is how long it'll take to refill all of the tokens

This will block, at first, atleast one period until its filled

pub fn get_available_tokens(&self) -> u64

Get the current available tokens

pub fn get_current_rate_class(&self) -> Option<RateClass>

Tries to get the current RateClass.

pub fn consume(&mut self, tokens: u64) -> Result<u64, Duration>

Consume a specific ammount of tokens

Returns

• Successful consumption (e.g. not blocking) will return how many tokens are left
• Failure to consume (e.g. out of tokens) will return a Duration of when the bucket will be refilled

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl Default for RateLimit

fn default() -> Self

Returns the "default value" for a type.