Struct Timeout

pub struct Timeout<S> { /* private fields */ }

Available on crate feature timeout only.

Middleware which apply a timeout to requests.

If the request does not complete within the specified timeout it will be aborted and a 408 Request Timeout response will be sent.

See the module docs for an example.

Implementations

impl<S> Timeout<S>

pub fn new(inner: S, timeout: Duration) -> Self

Creates a new Timeout.

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

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

Gets a mutable reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn layer(timeout: Duration) -> TimeoutLayer

Returns a new Layer that wraps services with a Timeout middleware.

Trait Implementations

impl<S: Clone> Clone for Timeout<S>

fn clone(&self) -> Timeout<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Timeout<S>

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

Formats the value using the given formatter.

impl<S, ReqBody, ResBody> Service<Request<ReqBody>> for Timeout<S>

where S: Service<Request<ReqBody>, Response = Response<ResBody>>, ResBody: Default,

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

Responses given by the service.

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

Errors produced by the service.

type Future = ResponseFuture<<S as Service<Request<ReqBody>>>::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, req: Request<ReqBody>) -> Self::Future

Process the request and return the response asynchronously.

impl<S: Copy> Copy for Timeout<S>