pub struct RateLimiter<BA, BO, F> { /* private fields */ }
Expand description

Rate limit middleware.

Implementations§

source§

impl<BA, BI, BO, F, O> RateLimiter<BA, BO, F>
where BA: Backend<BI, Output = BO> + 'static, BI: 'static, F: Fn(&ServiceRequest) -> O + 'static, O: Future<Output = Result<BI, Error>>,

source

pub fn builder(backend: BA, input_fn: F) -> RateLimiterBuilder<BA, BO, F>

Arguments
  • backend: A rate limiting algorithm and store implementation.
  • input_fn: A future that produces input to the backend based on the incoming request.

Trait Implementations§

source§

impl<BA, BI, BO, F, O> Clone for RateLimiter<BA, BO, F>
where BA: Backend<BI> + 'static, BI: 'static, F: Fn(&ServiceRequest) -> O + 'static, O: Future<Output = Result<BI, Error>>,

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<S, B, BA, BI, BO, BE, F, O> Transform<S, ServiceRequest> for RateLimiter<BA, BO, F>
where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static, S::Future: 'static, B: 'static, BA: Backend<BI, Output = BO, Error = BE> + 'static, BI: 'static, BO: 'static, BE: Into<Error> + Display + 'static, F: Fn(&ServiceRequest) -> O + 'static, O: Future<Output = Result<BI, Error>>,

§

type Response = ServiceResponse<EitherBody<B>>

Responses produced by the service.
§

type Error = Error

Errors produced by the service.
§

type Transform = RateLimiterMiddleware<S, BA, BO, F>

The TransformService value created by this factory
§

type InitError = ()

Errors produced while building a transform service.
§

type Future = Ready<Result<<RateLimiter<BA, BO, F> as Transform<S, ServiceRequest>>::Transform, <RateLimiter<BA, BO, F> as Transform<S, ServiceRequest>>::InitError>>

The future response value.
source§

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

Auto Trait Implementations§

§

impl<BA, BO, F> !RefUnwindSafe for RateLimiter<BA, BO, F>

§

impl<BA, BO, F> !Send for RateLimiter<BA, BO, F>

§

impl<BA, BO, F> !Sync for RateLimiter<BA, BO, F>

§

impl<BA, BO, F> Unpin for RateLimiter<BA, BO, F>
where BA: Unpin,

§

impl<BA, BO, F> !UnwindSafe for RateLimiter<BA, BO, F>

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> 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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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