Struct RateLimit

pub struct RateLimit { /* private fields */ }

Available on crate feature time only.

Given a Rate this type enforces a rate limit.

Implementations

impl RateLimit

pub fn new(rate: Rate) -> Self

Create a new rate limiter

pub const fn limit(&self) -> u64

Returns the configured limit of the RateLimit

pub fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<()>

Checks if the RateLimit is ready to handle a new call

pub async fn wait(&mut self)

Wait until the RateLimit is ready.

pub fn tick(&mut self)

Updates the RateLimit when a new call was triggered

Panics

Panics if RateLimit::poll_ready returned Poll::Pending

Trait Implementations

impl Debug for RateLimit

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes