pub struct Builder { /* private fields */ }server only.Expand description
A configuration builder for HTTP/1 server connections.
Implementations§
source§impl Builder
impl Builder
sourcepub fn half_close(&mut self, val: bool) -> &mut Self
pub fn half_close(&mut self, val: bool) -> &mut Self
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.
sourcepub fn keep_alive(&mut self, val: bool) -> &mut Self
pub fn keep_alive(&mut self, val: bool) -> &mut Self
Enables or disables HTTP/1 keep-alive.
Default is true.
sourcepub fn title_case_headers(&mut self, enabled: bool) -> &mut Self
pub fn title_case_headers(&mut self, enabled: bool) -> &mut Self
Set whether HTTP/1 connections will write header names as title case at the socket level.
Default is false.
sourcepub fn preserve_header_case(&mut self, enabled: bool) -> &mut Self
pub fn preserve_header_case(&mut self, enabled: bool) -> &mut Self
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.
Default is false.
sourcepub fn header_read_timeout(&mut self, read_timeout: Duration) -> &mut Self
pub fn header_read_timeout(&mut self, read_timeout: Duration) -> &mut Self
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.
sourcepub fn writev(&mut self, val: bool) -> &mut Self
pub fn writev(&mut self, val: bool) -> &mut Self
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
sourcepub fn max_buf_size(&mut self, max: usize) -> &mut Self
pub fn max_buf_size(&mut self, max: usize) -> &mut Self
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.
sourcepub fn pipeline_flush(&mut self, enabled: bool) -> &mut Self
pub fn pipeline_flush(&mut self, enabled: bool) -> &mut Self
Aggregates flushes to better support pipelined responses.
Experimental, may have bugs.
Default is false.
sourcepub fn timer<M>(&mut self, timer: M) -> &mut Selfwhere
M: Timer + Send + Sync + 'static,
pub fn timer<M>(&mut self, timer: M) -> &mut Selfwhere
M: Timer + Send + Sync + 'static,
Set the timer used in background tasks.
sourcepub fn serve_connection<I, S>(&self, io: I, service: S) -> Connection<I, S> ⓘwhere
S: HttpService<IncomingBody>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
S::ResBody: 'static,
<S::ResBody as Body>::Error: Into<Box<dyn StdError + Send + Sync>>,
I: AsyncRead + AsyncWrite + Unpin,
pub fn serve_connection<I, S>(&self, io: I, service: S) -> Connection<I, S> ⓘwhere
S: HttpService<IncomingBody>,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
S::ResBody: 'static,
<S::ResBody as Body>::Error: Into<Box<dyn StdError + Send + Sync>>,
I: AsyncRead + AsyncWrite + Unpin,
Bind a connection together with a Service.
This returns a Future that must be polled in order for HTTP to be driven on the connection.
Example
let http = Builder::new();
let conn = http.serve_connection(some_io, some_service);
if let Err(e) = conn.await {
eprintln!("server connection error: {}", e);
}