Struct tower::limit::rate::RateLimit

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

Available on crate feature limit only.

Enforces a rate limit on the number of requests the underlying service can handle over a period of time.

Implementations

impl<T> RateLimit<T>

pub fn new(inner: T, rate: Rate) -> Self

Create a new rate limiter

pub fn get_ref(&self) -> &T

Get a reference to the inner service

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the inner service

pub fn into_inner(self) -> T

Consume self, returning the inner service

Trait Implementations

impl<T: Debug> Debug for RateLimit<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Load for RateLimit<S>

where S: Load,

Available on crate feature load only.

type Metric = <S as Load>::Metric

A comparable load metric.

fn load(&self) -> Self::Metric

Estimate the service’s current load.

impl<S, Request> Service<Request> for RateLimit<S>

where S: Service<Request>,

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

Responses given by the service.

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

Errors produced by the service.

type Future = <S as Service<Request>>::Future

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, request: Request) -> Self::Future

Process the request and return the response asynchronously.