pub struct RateLimit<T, ExtractKey, BypassForKey, Key> { /* private fields */ }
Expand description
Enforces a rate limit on the number of requests the underlying service can handle over a period of time.
Read module documentation for more information.
Implementations
sourceimpl<S, ExtractKey, BypassForKey, Key> RateLimit<S, ExtractKey, BypassForKey, Key> where
ExtractKey: Fn(&mut BoxRequest) -> Option<Key>,
BypassForKey: Fn(&Key) -> bool,
Key: Eq + Hash,
impl<S, ExtractKey, BypassForKey, Key> RateLimit<S, ExtractKey, BypassForKey, Key> where
ExtractKey: Fn(&mut BoxRequest) -> Option<Key>,
BypassForKey: Fn(&Key) -> bool,
Key: Eq + Hash,
sourcepub fn new(
inner: S,
rate: Rate,
extract_key: ExtractKey,
bypass_for_key: BypassForKey
) -> Self
pub fn new(
inner: S,
rate: Rate,
extract_key: ExtractKey,
bypass_for_key: BypassForKey
) -> Self
Create a new rate limiter.
sourcepub fn into_inner(self) -> S
pub fn into_inner(self) -> S
Consume self
, returning the inner service.
Trait Implementations
sourceimpl<S, ExtractKey, BypassForKey, Key> Service<Request<()>> for RateLimit<S, ExtractKey, BypassForKey, Key> where
S: Service<BoxRequest, Response = BoxResponse, Error = Infallible>,
ExtractKey: Fn(&mut BoxRequest) -> Option<Key>,
BypassForKey: Fn(&Key) -> bool,
Key: Eq + Hash,
impl<S, ExtractKey, BypassForKey, Key> Service<Request<()>> for RateLimit<S, ExtractKey, BypassForKey, Key> where
S: Service<BoxRequest, Response = BoxResponse, Error = Infallible>,
ExtractKey: Fn(&mut BoxRequest) -> Option<Key>,
BypassForKey: Fn(&Key) -> bool,
Key: Eq + Hash,
type Future = RateLimitFuture<S::Future>
type Future = RateLimitFuture<S::Future>
The future response value.
sourcefn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>
fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>
Returns Poll::Ready(Ok(()))
when the service is able to process requests. Read more
sourcefn call(&mut self, request: BoxRequest) -> Self::Future
fn call(&mut self, request: BoxRequest) -> Self::Future
Process the request and return the response asynchronously. Read more
Auto Trait Implementations
impl<T, ExtractKey, BypassForKey, Key> RefUnwindSafe for RateLimit<T, ExtractKey, BypassForKey, Key> where
BypassForKey: RefUnwindSafe,
ExtractKey: RefUnwindSafe,
Key: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, ExtractKey, BypassForKey, Key> Send for RateLimit<T, ExtractKey, BypassForKey, Key> where
BypassForKey: Send,
ExtractKey: Send,
Key: Send,
T: Send,
impl<T, ExtractKey, BypassForKey, Key> Sync for RateLimit<T, ExtractKey, BypassForKey, Key> where
BypassForKey: Sync,
ExtractKey: Sync,
Key: Sync,
T: Sync,
impl<T, ExtractKey, BypassForKey, Key> Unpin for RateLimit<T, ExtractKey, BypassForKey, Key> where
BypassForKey: Unpin,
ExtractKey: Unpin,
Key: Unpin,
T: Unpin,
impl<T, ExtractKey, BypassForKey, Key> UnwindSafe for RateLimit<T, ExtractKey, BypassForKey, Key> where
BypassForKey: UnwindSafe,
ExtractKey: UnwindSafe,
Key: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,
impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,
sourcefn ready(&mut self) -> Ready<'_, Self, Request>ⓘNotable traits for Ready<'a, T, Request>impl<'a, T, Request> Future for Ready<'a, T, Request> where
T: Service<Request>, type Output = Result<&'a mut T, <T as Service<Request>>::Error>;
fn ready(&mut self) -> Ready<'_, Self, Request>ⓘNotable traits for Ready<'a, T, Request>impl<'a, T, Request> Future for Ready<'a, T, Request> where
T: Service<Request>, type Output = Result<&'a mut T, <T as Service<Request>>::Error>;
T: Service<Request>, type Output = Result<&'a mut T, <T as Service<Request>>::Error>;
Yields a mutable reference to the service when it is ready to accept a request.
sourcefn ready_and(&mut self) -> Ready<'_, Self, Request>ⓘNotable traits for Ready<'a, T, Request>impl<'a, T, Request> Future for Ready<'a, T, Request> where
T: Service<Request>, type Output = Result<&'a mut T, <T as Service<Request>>::Error>;
fn ready_and(&mut self) -> Ready<'_, Self, Request>ⓘNotable traits for Ready<'a, T, Request>impl<'a, T, Request> Future for Ready<'a, T, Request> where
T: Service<Request>, type Output = Result<&'a mut T, <T as Service<Request>>::Error>;
T: Service<Request>, type Output = Result<&'a mut T, <T as Service<Request>>::Error>;
please use the ServiceExt::ready
method instead
Yields a mutable reference to the service when it is ready to accept a request.
sourcefn ready_oneshot(self) -> ReadyOneshot<Self, Request>ⓘNotable traits for ReadyOneshot<T, Request>impl<T, Request> Future for ReadyOneshot<T, Request> where
T: Service<Request>, type Output = Result<T, <T as Service<Request>>::Error>;
fn ready_oneshot(self) -> ReadyOneshot<Self, Request>ⓘNotable traits for ReadyOneshot<T, Request>impl<T, Request> Future for ReadyOneshot<T, Request> where
T: Service<Request>, type Output = Result<T, <T as Service<Request>>::Error>;
T: Service<Request>, type Output = Result<T, <T as Service<Request>>::Error>;
Yields the service when it is ready to accept a request.
sourcefn oneshot(self, req: Request) -> Oneshot<Self, Request>ⓘNotable traits for Oneshot<S, Req>impl<S, Req> Future for Oneshot<S, Req> where
S: Service<Req>, type Output = Result<<S as Service<Req>>::Response, <S as Service<Req>>::Error>;
fn oneshot(self, req: Request) -> Oneshot<Self, Request>ⓘNotable traits for Oneshot<S, Req>impl<S, Req> Future for Oneshot<S, Req> where
S: Service<Req>, type Output = Result<<S as Service<Req>>::Response, <S as Service<Req>>::Error>;
S: Service<Req>, type Output = Result<<S as Service<Req>>::Response, <S as Service<Req>>::Error>;
Consume this Service
, calling with the providing request once it is ready.
sourcefn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Send + Sync + 'static, Global>>,
sourcefn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,
fn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,
Executes a new future after this service’s future resolves. This does
not alter the behaviour of the poll_ready
method. Read more
sourcefn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,
fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,
Maps this service’s response value to a different value. This does not
alter the behaviour of the poll_ready
method. Read more
sourcefn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,
fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,
Maps this service’s error value to a different value. This does not
alter the behaviour of the poll_ready
method. Read more
sourcefn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,
fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,
Maps this service’s result type (Result<Self::Response, Self::Error>
)
to a different value, regardless of whether the future succeeds or
fails. Read more
sourcefn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,
fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,
Composes a function in front of the service. Read more
sourcefn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,
fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,
Composes an asynchronous function after this service. Read more
sourcefn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,
fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,
Composes a function that transforms futures produced by the service. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more