Skip to main content

RateLimit

xitca_web::middleware::rate_limit

Struct RateLimit 

Source 
pub struct RateLimit(/* private fields */);
Expand description

builder for client ip address based rate limiting middleware.

§Examples

App::new()
    .at("/", get(handler_service(|| async { "hello,world!" })))
    // rate limit to 60 rps for one ip address.
    .enclosed(RateLimit::per_minute(60));

Implementations§

Source§

impl RateLimit

Source

pub fn per_second(max_burst: u32) -> Self

Construct a RateLimit for a number of cells per_second period. The given number of cells is also assumed to be the maximum burst size.

§Panics
  • When max_burst is zero.
Source

pub fn per_minute(max_burst: u32) -> Self

Construct a RateLimit for a number of cells per_minute period. The given number of cells is also assumed to be the maximum burst size.

§Panics
  • When max_burst is zero.
Source

pub fn per_hour(max_burst: u32) -> Self

Construct a RateLimit for a number of cells per_hour period. The given number of cells is also assumed to be the maximum burst size.

§Panics
  • When max_burst is zero.
Source

pub fn with_period(replenish_1_per: Duration) -> Self

Construct a RateLimit that replenishes one cell in a given interval.

§Panics
  • When the Duration is zero.

Trait Implementations§

Source§

impl<S, E> Service<Result<S, E>> for RateLimit

Source§

type Response = RateLimitService<S>

The Ok part of output future.
Source§

type Error = E

The Err part of output future.
Source§

async fn call(&self, res: Result<S, E>) -> Result<Self::Response, Self::Error>

Auto Trait Implementations§

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> BorrowState<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<S, Arg> ServiceExt<Arg> for S
where S: Service<Arg>,

Source§

fn enclosed<T>(self, build: T) -> Pipeline<Self, T, BuildEnclosed>
where T: Service<Result<Self::Response, Self::Error>>, Self: Sized,

Enclose Self with given T as Service<<Self as Service<_>>::Response>>. In other word T would take Self’s Service::Response type as it’s generic argument of Service<_> impl.
Source§

fn enclosed_fn<T, Req, O>( self, func: T, ) -> Pipeline<Self, AsyncFn<T>, BuildEnclosed>
where T: AsyncFn(&Self::Response, Req) -> O + Clone, Self: Sized,

Function version of Self::enclosed method.
Source§

fn map<F, Res, ResMap>(self, mapper: F) -> Pipeline<Self, Map<F>, BuildEnclosed>
where F: Fn(Res) -> ResMap + Clone, Self: Sized,

Mutate <<Self::Response as Service<Req>>::Future as Future>::Output type with given closure.
Source§

fn map_err<F, Err, ErrMap>( self, err: F, ) -> Pipeline<Self, MapErr<F>, BuildEnclosed>
where F: Fn(Err) -> ErrMap + Clone, Self: Sized,

Mutate <Self::Response as Service<Req>>::Error type with given closure.
Source§

fn and_then<F>(self, factory: F) -> Pipeline<Self, F, BuildAndThen>
where F: Service<Arg>, Self: Sized,

Chain another service factory who’s service takes Self’s Service::Response output as Service::Request.
Source§

impl<S, Req> ServiceObject<Req> for S
where S: Service<Req>,

Source§

type Response = <S as Service<Req>>::Response

Source§

type Error = <S as Service<Req>>::Error

Source§

fn call<'s>( &'s self, req: Req, ) -> Pin<Box<dyn Future<Output = Result<<S as ServiceObject<Req>>::Response, <S as ServiceObject<Req>>::Error>> + 's>>
where Req: 's,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more