Struct hyper::client::conn::Builder

pub struct Builder { /* private fields */ }

A builder to configure an HTTP connection.

After setting options, the builder is used to create a handshake future.

Implementations

impl Builder

pub fn new() -> Builder

Creates a new connection builder.

pub fn executor<E>(&mut self, exec: E) -> &mut Builderwhere E: Executor<Pin<Box<dyn Future<Output = ()> + Send>>> + Send + Sync + 'static,

Provide an executor to execute background HTTP2 tasks.

pub fn http09_responses(&mut self, enabled: bool) -> &mut Builder

Set whether HTTP/0.9 responses should be tolerated.

Default is false.

pub fn http1_allow_spaces_after_header_name_in_responses( &mut self, enabled: bool ) -> &mut Builder

Set whether HTTP/1 connections will accept spaces between header names and the colon that follow them in responses.

You probably don’t need this, here is what RFC 7230 Section 3.2.4. has to say about it:

No whitespace is allowed between the header field-name and colon. In the past, differences in the handling of such whitespace have led to security vulnerabilities in request routing and response handling. A server MUST reject any received request message that contains whitespace between a header field-name and colon with a response code of 400 (Bad Request). A proxy MUST remove any such whitespace from a response message before forwarding the message downstream.

Note that this setting does not affect HTTP/2.

Default is false.

pub fn http1_allow_obsolete_multiline_headers_in_responses( &mut self, enabled: bool ) -> &mut Builder

Set whether HTTP/1 connections will accept obsolete line folding for header values.

Newline codepoints (\r and \n) will be transformed to spaces when parsing.

You probably don’t need this, here is what RFC 7230 Section 3.2.4. has to say about it:

A server that receives an obs-fold in a request message that is not within a message/http container MUST either reject the message by sending a 400 (Bad Request), preferably with a representation explaining that obsolete line folding is unacceptable, or replace each received obs-fold with one or more SP octets prior to interpreting the field value or forwarding the message downstream.

A proxy or gateway that receives an obs-fold in a response message that is not within a message/http container MUST either discard the message and replace it with a 502 (Bad Gateway) response, preferably with a representation explaining that unacceptable line folding was received, or replace each received obs-fold with one or more SP octets prior to interpreting the field value or forwarding the message downstream.

A user agent that receives an obs-fold in a response message that is not within a message/http container MUST replace each received obs-fold with one or more SP octets prior to interpreting the field value.

Note that this setting does not affect HTTP/2.

Default is false.

pub fn http1_ignore_invalid_headers_in_responses( &mut self, enabled: bool ) -> &mut Builder

Set whether HTTP/1 connections will silently ignored malformed header lines.

If this is enabled and and a header line does not start with a valid header name, or does not include a colon at all, the line will be silently ignored and no error will be reported.

Note that this setting does not affect HTTP/2.

Default is false.

pub fn http1_writev(&mut self, enabled: bool) -> &mut Builder

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 http1_title_case_headers(&mut self, enabled: bool) -> &mut Builder

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 Builder

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 Response. It will also look for and use such an extension in any provided Request.

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_read_buf_exact_size(&mut self, sz: Option<usize>) -> &mut Builder

Sets the exact size of the read buffer to always use.

Note that setting this option unsets the http1_max_buf_size option.

Default is an adaptive read buffer.

pub fn http1_max_buf_size(&mut self, max: usize) -> &mut Self

Set the maximum buffer size for the connection.

Default is ~400kb.

Note that setting this option unsets the http1_read_exact_buf_size option.

Panics

The minimum value allowed is 8192. This method panics if the passed max is less than the minimum.

pub fn http2_only(&mut self, enabled: bool) -> &mut Builder

Sets whether HTTP2 is required.

Default is false.

pub fn http2_initial_stream_window_size( &mut self, sz: impl Into<Option<u32>> ) -> &mut Self

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 Self

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 Self

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 Self

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_keep_alive_interval( &mut self, interval: impl Into<Option<Duration>> ) -> &mut Self

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 Self

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_keep_alive_while_idle(&mut self, enabled: bool) -> &mut Self

Sets whether HTTP2 keep-alive should apply while the connection is idle.

If disabled, keep-alive pings are only sent while there are open request/responses streams. If enabled, pings are also sent when no streams are active. Does nothing if http2_keep_alive_interval is disabled.

Default is false.

Cargo Feature

Requires the runtime cargo feature to be enabled.

pub fn http2_max_concurrent_reset_streams(&mut self, max: usize) -> &mut Self

Sets the maximum number of HTTP2 concurrent locally reset streams.

See the documentation of h2::client::Builder::max_concurrent_reset_streams for more details.

The default value is determined by the h2 crate.

pub fn http2_max_send_buf_size(&mut self, max: usize) -> &mut Self

Set the maximum write buffer size for each HTTP/2 stream.

Default is currently 1MB, but may change.

Panics

The value must be no larger than u32::MAX.

pub fn handshake<T, B>( &self, io: T ) -> impl Future<Output = Result<(SendRequest<B>, Connection<T, B>)>>where T: AsyncRead + AsyncWrite + Unpin + Send + 'static, B: HttpBody + 'static, B::Data: Send, B::Error: Into<Box<dyn StdError + Send + Sync>>,

Constructs a connection with the configured options and IO. See client::conn for more.

Note, if Connection is not await-ed, SendRequest will do nothing.

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.