Struct tower::limit::rate::RateLimit[−][src]

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

Expand description

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

Implementations

[src]

impl<T> RateLimit<T>

[src]

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

Create a new rate limiter

[src]

pub fn get_ref(&self) -> &T

Get a reference to the inner service

[src]

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

Get a mutable reference to the inner service

[src]

pub fn into_inner(self) -> T

Consume self, returning the inner service

Trait Implementations

[src]

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

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<S> Load for RateLimit<S> where
S: Load,

type Metric = S::Metric

A comparable load metric. Read more

[src]

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

Estimate the service’s current load.

[src]

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

type Response = S::Response

Responses given by the service.

type Error = S::Error

Errors produced by the service.

type Future = S::Future

The future response value.

[src]

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

[src]

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

Process the request and return the response asynchronously. Read more

Auto Trait Implementations

impl<T> !RefUnwindSafe for RateLimit<T>

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> !UnwindSafe for RateLimit<T>

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

[src]

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::Error>;`
where
Self: Sized,

Yields a mutable reference to the service when it is ready to accept a request.

[src]

fn ready_and(&mut self) -> ReadyAnd<'_, Self, Request> where
Self: Sized,

👎 Deprecated since 0.4.6:

please use the ServiceExt::ready method instead

Yields a mutable reference to the service when it is ready to accept a request.

[src]

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::Error>;`
where
Self: Sized,

Yields the service when it is ready to accept a request.

[src]

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::Response, S::Error>;`
where
Self: Sized,

Consume this Service, calling with the providing request once it is ready.

[src]

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
 Self: Sized,
 Self::Error: Into<BoxError>,
 S: Stream<Item = Request>,

Process all requests from the given Stream, and produce a Stream of their responses. Read more

[src]

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
Self: Sized,
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

[src]

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
Self: Sized,
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

[src]

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
Self: Sized,
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

[src]

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
 Self: Sized,
 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

[src]

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
Self: Sized,
F: FnMut(NewRequest) -> Request + Clone,

Composes a function in front of the service. Read more

[src]

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
 Self: Sized,
 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

[src]

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
 Self: Sized,
 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

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

[src]

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

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct tower::limit::rate::RateLimit[−][src]

Implementations

impl<T> RateLimit<T>

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

pub fn get_ref(&self) -> &T

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

pub fn into_inner(self) -> T

Trait Implementations

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

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

impl<S> Load for RateLimit<S> where S: Load,

type Metric = S::Metric

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

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

type Response = S::Response

type Error = S::Error

type Future = S::Future

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

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for RateLimit<T>

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> !UnwindSafe for RateLimit<T>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, Request> ServiceExt<Request> for T where T: Service<Request> + ?Sized,

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::Error>; where Self: Sized,

fn ready_and(&mut self) -> ReadyAnd<'_, Self, Request> where Self: Sized,

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::Error>; where Self: Sized,

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::Response, S::Error>; where Self: Sized,

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where Self: Sized, Self::Error: Into<BoxError>, S: Stream<Item = Request>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where Self: Sized, F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where Self: Sized, F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where Self: Sized, F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where Self: Sized, F: FnMut(NewRequest) -> Request + Clone,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone, Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where Self: Sized, F: FnMut(Self::Future) -> Fut, Error: From<Self::Error>, Fut: Future<Output = Result<Response, Error>>,

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<S> Load for RateLimit<S> where
S: Load,

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

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> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

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::Error>;`
where
Self: Sized,

fn ready_and(&mut self) -> ReadyAnd<'_, Self, Request> where
Self: Sized,

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::Error>;`
where
Self: Sized,

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::Response, S::Error>;`
where
Self: Sized,

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
Self: Sized,
Self::Error: Into<BoxError>,
S: Stream<Item = Request>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
Self: Sized,
F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
Self: Sized,
F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
Self: Sized,
F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Self: Sized,
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
Self: Sized,
F: FnMut(NewRequest) -> Request + Clone,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
Self: Sized,
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
Self: Sized,
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

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