Skip to main content

RateLimiter

throttle_kit

Struct RateLimiter 

Source 
pub struct RateLimiter<B: RateLimitBackend> { /* private fields */ }
Expand description

Core rate limiter that delegates to a RateLimitBackend.

Implementations§

Source§

impl<B: RateLimitBackend> RateLimiter<B>

Source

pub fn new(quota: Quota, backend: B) -> Self

Create a new rate limiter with the given quota and backend.

Source

pub async fn check(&self, key: &str) -> RateLimitResult

Check whether the caller identified by key is allowed to proceed.

Source

pub fn check_sync(&self, key: &str) -> RateLimitResult

Synchronous version of check.

Blocks the current thread until the check completes. Useful for synchronous frameworks (e.g. Actix, Rocket).

Trait Implementations§

Source§

impl<B: Clone + RateLimitBackend> Clone for RateLimiter<B>

Source§

fn clone(&self) -> RateLimiter<B>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<B> Freeze for RateLimiter<B>
where Arc<B>: Freeze,

§

impl<B> RefUnwindSafe for RateLimiter<B>
where Arc<B>: RefUnwindSafe,

§

impl<B> Send for RateLimiter<B>
where Arc<B>: Send,

§

impl<B> Sync for RateLimiter<B>
where Arc<B>: Sync,

§

impl<B> Unpin for RateLimiter<B>
where Arc<B>: Unpin,

§

impl<B> UnsafeUnpin for RateLimiter<B>
where Arc<B>: UnsafeUnpin,

§

impl<B> UnwindSafe for RateLimiter<B>
where Arc<B>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.