Struct Builder

pub struct Builder { /* private fields */ }

A configuration builder for HTTP/1 server connections.

Note: The default values of options are not considered stable. They are subject to change at any time.

Example

let mut http = Builder::new();
// Set options one at a time
http.half_close(false);

// Or, chain multiple options
http.keep_alive(false).title_case_headers(true).max_buf_size(8192);

Use Builder::serve_connection to bind the built connection to a service.

Implementations

impl Builder

pub fn new() -> Self

Create a new connection builder.

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.

pub fn keep_alive(&mut self, val: bool) -> &mut Self

Enables or disables HTTP/1 keep-alive.

Default is true.

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.

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.

pub fn max_headers(&mut self, val: usize) -> &mut Self

Set the maximum number of headers.

When a request is received, the parser will reserve a buffer to store headers for optimal performance.

If server receives more headers than the buffer size, it responds to the client with “431 Request Header Fields Too Large”.

Note that headers is allocated on the stack by default, which has higher performance. After setting this value, headers will be allocated in heap memory, that is, heap memory allocation will occur for each request, and there will be a performance drop of about 5%.

Default is 100.

pub fn header_read_timeout( &mut self, read_timeout: impl Into<Option<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.

Requires a Timer set by Builder::timer to take effect. Panics if header_read_timeout is configured without a Timer.

Pass None to disable.

Default is 30 seconds.

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

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.

pub fn auto_date_header(&mut self, enabled: bool) -> &mut Self

Set whether the date header should be included in HTTP responses.

Note that including the date header is recommended by RFC 7231.

Default is true.

pub fn pipeline_flush(&mut self, enabled: bool) -> &mut Self

Aggregates flushes to better support pipelined responses.

Experimental, may have bugs.

Default is false.

pub fn timer<M>(&mut self, timer: M) -> &mut Self

where M: Timer + Send + Sync + 'static,

Set the timer used in background tasks.

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: Read + Write + 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.

Panics

If a timeout option has been configured, but a timer has not been provided, calling serve_connection will panic.

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);
}

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.