Struct salvo::hyper::client::Builder

pub struct Builder { /* fields omitted */ }

A builder to configure a new Client.

Example

use std::time::Duration;
use hyper::Client;

let client = Client::builder()
    .pool_idle_timeout(Duration::from_secs(30))
    .http2_only(true)
    .build_http();

Implementations

impl Builder

pub fn pool_idle_timeout<D>(&mut self, val: D) -> &mut Builder 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 pool_max_idle_per_host(&mut self, max_idle: usize) -> &mut Builder

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

Default is usize::MAX (no limit).

pub fn http1_read_buf_exact_size(&mut self, sz: 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 Builder

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

Set whether HTTP/0.9 responses should be tolerated.

Default is false.

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

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 http2_initial_stream_window_size(
    &mut self,
    sz: impl Into<Option<u32>>
) -> &mut Builder

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 Builder

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 Builder

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 Builder

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 Builder

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 Builder

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 Builder

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

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 Builder

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 Builder where
    E: Executor<Pin<Box<dyn Future<Output = ()> + 'static + Send, Global>>> + Send + Sync + 'static, 

Provide an executor to execute background Connection tasks.

pub fn build_http<B>(&self) -> Client<HttpConnector<GaiResolver>, B> where
    B: Body + Send,
    <B as Body>::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 + Clone,
    B: Body + Send,
    <B as Body>::Data: Send, 

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

Trait Implementations

impl Clone for Builder

pub 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

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

Formats the value using the given formatter.

impl Default for Builder

pub fn default() -> Builder

Returns the “default value” for a type.