Skip to main content

RateLimit

Struct RateLimit 

Source
pub struct RateLimit<T> { /* private fields */ }
Expand description

Async rate limit implementation

use std::time::Duration;
use rate_limit_wrapper::RateLimit;

#[tokio::main]
async fn main() {
  // 10 requests per second
  let rm = RateLimit::new(10, Duration::from_secs(1), reqwest::Client::new());

  // Access inner client bypassing rate limit
  let request = rm.as_ref().get("https://www.rust-lang.org").build().unwrap();

  // Apply rate limit
  let client = rm.rate_limit(1).await;
  client.execute(request).await.unwrap();
}

Implementations§

Source§

impl<T> RateLimit<T>

Source

pub fn new(size: usize, window: Duration, inner: T) -> Self

Source

pub fn rate_limit(&self, weight: usize) -> RateLimitFuture<'_, T>

Trait Implementations§

Source§

impl<T> AsRef<T> for RateLimit<T>

Source§

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

Auto Trait Implementations§

§

impl<T> !Freeze for RateLimit<T>

§

impl<T> RefUnwindSafe for RateLimit<T>
where T: RefUnwindSafe,

§

impl<T> Send for RateLimit<T>
where T: Send,

§

impl<T> Sync for RateLimit<T>
where T: Sync,

§

impl<T> Unpin for RateLimit<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for RateLimit<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for RateLimit<T>
where T: 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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.