Module timeout 

Available on crate feature timeout only.

Middleware that applies a timeout to requests.

If the request does not complete within the specified timeout, it will be aborted and a response with an empty body and a custom status code will be returned.

Differences from tower::timeout

tower’s Timeout middleware uses an error to signal timeout, i.e. it changes the error type to BoxError. For HTTP services that is rarely what you want as returning errors will terminate the connection without sending a response.

This middleware won’t change the error type and instead returns a response with an empty body and the specified status code. That means if your service’s error type is Infallible, it will still be Infallible after applying this middleware.

Body timeouts

Two body timeout wrappers are available for limiting how long a request or response body transfer can take:

• TimeoutBody resets its deadline each time a frame is received. Use this to detect idle connections where no data flows for a period of time.
• DeadlineBody starts a single timer at construction and never resets it. Use this to cap the total wall-clock time spent transferring a body, regardless of how frequently data arrives.

Both are applied via their corresponding layer types (RequestBodyTimeoutLayer / RequestBodyDeadlineLayer for request bodies, ResponseBodyTimeoutLayer / ResponseBodyDeadlineLayer for response bodies). They can be stacked if you want both an idle timeout and an absolute deadline.

Example

use http::{Request, Response, StatusCode};
use http_body_util::Full;
use bytes::Bytes;
use std::{convert::Infallible, time::Duration};
use tower::ServiceBuilder;
use tower_http::timeout::TimeoutLayer;

async fn handle(_: Request<Full<Bytes>>) -> Result<Response<Full<Bytes>>, Infallible> {
    // ...
}

let svc = ServiceBuilder::new()
    // Timeout requests after 30 seconds with the specified status code
    .layer(TimeoutLayer::with_status_code(StatusCode::REQUEST_TIMEOUT, Duration::from_secs(30)))
    .service_fn(handle);

Structs

DeadlineBody

Wrapper around a Body that enforces a hard deadline on the entire body transfer.

RequestBodyDeadline

Applies a DeadlineBody to the request body.

RequestBodyDeadlineLayer

Applies a DeadlineBody to the request body.

RequestBodyTimeout

Applies a TimeoutBody to the request body.

RequestBodyTimeoutLayer

Applies a TimeoutBody to the request body.

ResponseBodyDeadline

Applies a DeadlineBody to the response body.

ResponseBodyDeadlineLayer

Applies a DeadlineBody to the response body.

ResponseBodyTimeout

Applies a TimeoutBody to the response body.

ResponseBodyTimeoutLayer

Applies a TimeoutBody to the response body.

Timeout

Middleware which apply a timeout to requests.

TimeoutBody

Middleware that applies a timeout to request and response bodies.

TimeoutError

Error for TimeoutBody and DeadlineBody.

TimeoutLayer

Layer that applies the Timeout middleware which apply a timeout to requests.