pub struct Http<E = Exec> { /* private fields */ }
Expand description
A lower-level configuration of the HTTP protocol.
This structure is used to configure options for an HTTP server connection.
If you don’t have need to manage connections yourself, consider using the higher-level Server API.
Implementations
impl Http<Exec>
impl Http<Exec>
impl<E> Http<E>
impl<E> Http<E>
pub fn http1_only(&mut self, val: bool) -> &mut Http<E>
pub fn http1_only(&mut self, val: bool) -> &mut Http<E>
Sets whether HTTP1 is required.
Default is false
pub fn http1_half_close(&mut self, val: bool) -> &mut Http<E>
pub fn http1_half_close(&mut self, val: bool) -> &mut Http<E>
Set whether HTTP/1 connections should support half-closures.
Clients can chose to shutdown their write-side while waiting
for the server to respond. Setting this to true
will
prevent closing the connection immediately if read
detects an EOF in the middle of a request.
Default is false
.
pub fn http1_keep_alive(&mut self, val: bool) -> &mut Http<E>
pub fn http1_keep_alive(&mut self, val: bool) -> &mut Http<E>
Enables or disables HTTP/1 keep-alive.
Default is true.
pub fn http1_title_case_headers(&mut self, enabled: bool) -> &mut Http<E>
pub fn http1_title_case_headers(&mut self, enabled: bool) -> &mut Http<E>
Set whether HTTP/1 connections will write header names as title case at the socket level.
Note that this setting does not affect HTTP/2.
Default is false.
pub fn http1_preserve_header_case(&mut self, enabled: bool) -> &mut Http<E>
pub fn http1_preserve_header_case(&mut self, enabled: bool) -> &mut Http<E>
Set whether to support preserving original header cases.
Currently, this will record the original cases received, and store them
in a private extension on the Request
. It will also look for and use
such an extension in any provided Response
.
Since the relevant extension is still private, there is no way to interact with the original cases. The only effect this can have now is to forward the cases in a proxy-like fashion.
Note that this setting does not affect HTTP/2.
Default is false.
pub fn http1_header_read_timeout(
&mut self,
read_timeout: Duration
) -> &mut Http<E>
pub fn http1_header_read_timeout(
&mut self,
read_timeout: Duration
) -> &mut Http<E>
Set a timeout for reading client request headers. If a client does not transmit the entire header within this time, the connection is closed.
Default is None.
pub fn http1_writev(&mut self, val: bool) -> &mut Http<E>
pub fn http1_writev(&mut self, val: bool) -> &mut Http<E>
Set whether HTTP/1 connections should try to use vectored writes, or always flatten into a single buffer.
Note that setting this to false may mean more copies of body data, but may also improve performance when an IO transport doesn’t support vectored writes well, such as most TLS implementations.
Setting this to true will force hyper to use queued strategy which may eliminate unnecessary cloning on some TLS backends
Default is auto
. In this mode hyper will try to guess which
mode to use
pub fn http2_only(&mut self, val: bool) -> &mut Http<E>
pub fn http2_only(&mut self, val: bool) -> &mut Http<E>
Sets whether HTTP2 is required.
Default is false
pub fn http2_initial_stream_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Http<E>
pub fn http2_initial_stream_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Http<E>
Sets the SETTINGS_INITIAL_WINDOW_SIZE
option for HTTP2
stream-level flow control.
Passing None
will do nothing.
If not set, hyper will use a default.
pub fn http2_initial_connection_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Http<E>
pub fn http2_initial_connection_window_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Http<E>
Sets the max connection-level flow control for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
pub fn http2_adaptive_window(&mut self, enabled: bool) -> &mut Http<E>
pub fn http2_adaptive_window(&mut self, enabled: bool) -> &mut Http<E>
Sets whether to use an adaptive flow control.
Enabling this will override the limits set in
http2_initial_stream_window_size
and
http2_initial_connection_window_size
.
pub fn http2_max_frame_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Http<E>
pub fn http2_max_frame_size(
&mut self,
sz: impl Into<Option<u32>>
) -> &mut Http<E>
Sets the maximum frame size to use for HTTP2.
Passing None
will do nothing.
If not set, hyper will use a default.
pub fn http2_max_concurrent_streams(
&mut self,
max: impl Into<Option<u32>>
) -> &mut Http<E>
pub fn http2_max_concurrent_streams(
&mut self,
max: impl Into<Option<u32>>
) -> &mut Http<E>
Sets the SETTINGS_MAX_CONCURRENT_STREAMS
option for HTTP2
connections.
Default is no limit (std::u32::MAX
). Passing None
will do nothing.
pub fn http2_keep_alive_interval(
&mut self,
interval: impl Into<Option<Duration>>
) -> &mut Http<E>
pub fn http2_keep_alive_interval(
&mut self,
interval: impl Into<Option<Duration>>
) -> &mut Http<E>
Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.
Pass None
to disable HTTP2 keep-alive.
Default is currently disabled.
Cargo Feature
Requires the runtime
cargo feature to be enabled.
pub fn http2_keep_alive_timeout(&mut self, timeout: Duration) -> &mut Http<E>
pub fn http2_keep_alive_timeout(&mut self, timeout: Duration) -> &mut Http<E>
Sets a timeout for receiving an acknowledgement of the keep-alive ping.
If the ping is not acknowledged within the timeout, the connection will
be closed. Does nothing if http2_keep_alive_interval
is disabled.
Default is 20 seconds.
Cargo Feature
Requires the runtime
cargo feature to be enabled.
pub fn http2_max_send_buf_size(&mut self, max: usize) -> &mut Http<E>
pub fn http2_max_send_buf_size(&mut self, max: usize) -> &mut Http<E>
Set the maximum write buffer size for each HTTP/2 stream.
Default is currently ~400KB, but may change.
Panics
The value must be no larger than u32::MAX
.
pub fn http2_enable_connect_protocol(&mut self) -> &mut Http<E>
pub fn http2_enable_connect_protocol(&mut self) -> &mut Http<E>
Enables the extended CONNECT protocol.
pub fn max_buf_size(&mut self, max: usize) -> &mut Http<E>
pub fn max_buf_size(&mut self, max: usize) -> &mut Http<E>
Set the maximum buffer size for the connection.
Default is ~400kb.
Panics
The minimum value allowed is 8192. This method panics if the passed max
is less than the minimum.
pub fn pipeline_flush(&mut self, enabled: bool) -> &mut Http<E>
pub fn pipeline_flush(&mut self, enabled: bool) -> &mut Http<E>
Aggregates flushes to better support pipelined responses.
Experimental, may have bugs.
Default is false.
pub fn with_executor<E2>(self, exec: E2) -> Http<E2>
pub fn with_executor<E2>(self, exec: E2) -> Http<E2>
Set the executor used to spawn background tasks.
Default uses implicit default (like tokio::spawn
).
pub fn serve_connection<S, I, Bd>(
&self,
io: I,
service: S
) -> Connection<I, S, E>ⓘNotable traits for Connection<I, S, E>impl<I, B, S, E> Future for Connection<I, S, E> where
S: HttpService<Body, ResBody = B>,
I: 'static + AsyncRead + AsyncWrite + Unpin,
B: 'static + Body,
E: ConnStreamExec<<S as HttpService<Body>>::Future, B>,
<S as HttpService<Body>>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
<B as Body>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>, type Output = Result<(), Error>;
where
S: HttpService<Body, ResBody = Bd>,
Bd: 'static + Body,
I: AsyncRead + AsyncWrite + Unpin,
E: ConnStreamExec<<S as HttpService<Body>>::Future, Bd>,
<S as HttpService<Body>>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
<Bd as Body>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
pub fn serve_connection<S, I, Bd>(
&self,
io: I,
service: S
) -> Connection<I, S, E>ⓘNotable traits for Connection<I, S, E>impl<I, B, S, E> Future for Connection<I, S, E> where
S: HttpService<Body, ResBody = B>,
I: 'static + AsyncRead + AsyncWrite + Unpin,
B: 'static + Body,
E: ConnStreamExec<<S as HttpService<Body>>::Future, B>,
<S as HttpService<Body>>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
<B as Body>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>, type Output = Result<(), Error>;
where
S: HttpService<Body, ResBody = Bd>,
Bd: 'static + Body,
I: AsyncRead + AsyncWrite + Unpin,
E: ConnStreamExec<<S as HttpService<Body>>::Future, Bd>,
<S as HttpService<Body>>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
<Bd as Body>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
S: HttpService<Body, ResBody = B>,
I: 'static + AsyncRead + AsyncWrite + Unpin,
B: 'static + Body,
E: ConnStreamExec<<S as HttpService<Body>>::Future, B>,
<S as HttpService<Body>>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
<B as Body>::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>, type Output = Result<(), Error>;
Trait Implementations
Auto Trait Implementations
impl<E> RefUnwindSafe for Http<E> where
E: RefUnwindSafe,
impl<E> Send for Http<E> where
E: Send,
impl<E> Sync for Http<E> where
E: Sync,
impl<E> Unpin for Http<E> where
E: Unpin,
impl<E> UnwindSafe for Http<E> where
E: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more