Struct hyper::client::Builder

source · [−]

pub struct Builder { /* private fields */ }

Expand description

A builder to configure a new Client.

Example

use hyper::Client;

let client = Client::builder()
    .keep_alive(true)
    .http2_only(true)
    .build_http();

Implementations

source

impl Builder

source

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

Enable or disable keep-alive mechanics.

Default is enabled.

source

pub fn keep_alive_timeout<D>(&mut self, val: D) -> &mut Self where
D: Into<Option<Duration>>,

Set an optional timeout for idle sockets being kept-alive.

Pass None to disable timeout.

Default is 90 seconds.

source

pub fn http1_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.

Default is true.

source

pub fn http1_read_buf_exact_size(&mut self, sz: usize) -> &mut Self

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.

source

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.

source

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

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.

source

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

Set whether the connection must use HTTP/2.

The destination must either allow HTTP2 Prior Knowledge, or the Connect should be configured to do use ALPN to upgrade to h2 as part of the connection process. This will not make the Client utilize ALPN by itself.

Note that setting this to true prevents HTTP/1 from being allowed.

Default is false.

source

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.

Default is 65,535

source

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

Default is 65,535

source

pub fn max_idle_per_host(&mut self, max_idle: usize) -> &mut Self

Sets the maximum idle connection per host allowed in the pool.

Default is usize::MAX (no limit).

source

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

Set whether to retry requests that get disrupted before ever starting to write.

This means a request that is queued, and gets given an idle, reused connection, and then encounters an error immediately as the idle connection was found to be unusable.

When this is set to false, the related ResponseFuture would instead resolve to an Error::Cancel.

Default is true.

source