pub struct TimeoutLayer<A: ?Sized> { /* private fields */ }Expand description
Wraps any owned Application (or a shared Arc<dyn Application>) so
every request through it must complete within duration or the client
gets 504 Gateway Timeout instead of waiting further.
Use this to put one blanket timeout around an entire App/AppWithState/
custom Application. For different timeouts on different routes within
the same app, use with_timeout / with_timeout_state /
with_timeout_async on individual handlers instead.
Implementations§
Source§impl<A: Application + Send + Sync + 'static> TimeoutLayer<A>
impl<A: Application + Send + Sync + 'static> TimeoutLayer<A>
Trait Implementations§
Source§impl<A: Application + Send + Sync + ?Sized + 'static> Application for TimeoutLayer<A>
impl<A: Application + Send + Sync + ?Sized + 'static> Application for TimeoutLayer<A>
Source§fn execute(
&self,
request: &Request,
connection: &ConnectionInfo,
) -> Result<Response, String>
fn execute( &self, request: &Request, connection: &ConnectionInfo, ) -> Result<Response, String>
Receives a parsed request and returns a fully-built response.
Walk your controller list with
is_matching / process and return the first match.Source§fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool
fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool
true when executing request is quick and never waits on anything
but the local filesystem — health checks, metrics, small static files.
The async servers (HTTP/1.1, HTTP/2, HTTP/3) then call execute
directly on the event loop, as nginx does, instead of handing the
request to tokio’s blocking pool: that handoff (a shared lock and two
cross-thread wake-ups) costs more than serving a small file. Read moreSource§fn execute_async<'a>(
&'a self,
_request: &'a Request,
_connection: &'a ConnectionInfo,
) -> Option<AsyncResponse<'a>>
fn execute_async<'a>( &'a self, _request: &'a Request, _connection: &'a ConnectionInfo, ) -> Option<AsyncResponse<'a>>
An asynchronous version of
execute for this request, when the
application has one: the async servers await it on the connection’s
task instead of tying up a blocking-pool thread while it waits (the
config-driven proxy uses this to wait for a backend without holding a
thread). None (the default) means “use execute”. Wrappers return
Some only when they add no synchronous work of their own.Source§fn streams_body(&self, _request: &Request, _connection: &ConnectionInfo) -> bool
fn streams_body(&self, _request: &Request, _connection: &ConnectionInfo) -> bool
true to receive this request’s body as a stream (Body::Stream)
instead of read into memory first: execute then runs while the
body is still arriving, on a blocking-pool thread, and reads it with
std::io::Read — a multi-gigabyte upload in a few chunks of memory.
Asked after the head is read, so request.body is empty here;
decide from the method, path and headers. Read moreAuto Trait Implementations§
impl<A> Freeze for TimeoutLayer<A>
impl<A> RefUnwindSafe for TimeoutLayer<A>
impl<A> Send for TimeoutLayer<A>
impl<A> Sync for TimeoutLayer<A>
impl<A> Unpin for TimeoutLayer<A>
impl<A> UnsafeUnpin for TimeoutLayer<A>
impl<A> UnwindSafe for TimeoutLayer<A>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more