Struct TimeoutBody

pub struct TimeoutBody<B> { /* private fields */ }

Available on crate feature timeout only.

Middleware that applies a timeout to request and response bodies.

Wrapper around a Body to time out if data is not ready within the specified duration. The timeout is enforced between consecutive Frame polls, and it resets after each poll. The total time to produce a Body could exceed the timeout duration without timing out, as long as no single interval between polls exceeds the timeout.

If the Body does not produce a requested data frame within the timeout period, it will return a TimeoutError.

Differences from Timeout

Timeout applies a timeout to the request future, not body. That timeout is not reset when bytes are handled, whether the request is active or not. Bodies are handled asynchronously outside of the tower stack’s future and thus needs an additional timeout.

Example

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

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

let svc = ServiceBuilder::new()
    // Timeout bodies after 30 seconds of inactivity
    .layer(RequestBodyTimeoutLayer::new(Duration::from_secs(30)))
    .service_fn(handle);

Implementations

impl<B> TimeoutBody<B>

pub fn new(timeout: Duration, body: B) -> Self

Creates a new TimeoutBody.

Trait Implementations

impl<B> Body for TimeoutBody<B>

where B: Body, B::Error: Into<BoxError>,

type Data = <B as Body>::Data

Values yielded by the Body.

type Error = Box<dyn Error + Send + Sync>

The error type this Body might generate.

fn poll_frame( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

impl<'__pin, B> Unpin for TimeoutBody<B>

where PinnedFieldsOf<__Origin<'__pin, B>>: Unpin,