Struct hyper::client::Builder

pub struct Builder { /* fields omitted */ }

Builder for a Client

Methods

impl Builder

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

Enable or disable keep-alive mechanics.

Default is enabled.

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.

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.

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

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

Default is an adaptive read buffer.

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.

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.

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).

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.

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

Set whether to automatically add the Host header to requests.

If true, and a request does not include a Host header, one will be added automatically, derived from the authority of the Uri.

Default is true.

pub fn executor<E>(&mut self, exec: E) -> &mut Self where     E: Executor<Box<dyn Future<Item = (), Error = ()> + Send>> + Send + Sync + 'static,

Provide an executor to execute background Connection tasks.

pub fn build_http<B>(&self) -> Client<HttpConnector, B> where     B: Payload + Send,     B::Data: Send,

Builder a client with this configuration and the default HttpConnector.

pub fn build<C, B>(&self, connector: C) -> Client<C, B> where     C: Connect,     C::Transport: 'static,     C::Future: 'static,     B: Payload + Send,     B::Data: Send,

Combine the configuration of this builder with a connector to create a Client.

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 Default for Builder

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Builder

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

Formats the value using the given formatter.