Struct hyper::client::conn::Builder

pub struct Builder { /* fields omitted */ }

This is supported on crate feature client and (crate features http1 or http2) only.

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

Provide an executor to execute background HTTP2 tasks.

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

This is supported on crate feature http2 only.

Sets whether HTTP2 is required.

Default is false.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

This is supported on crate feature http2 only.

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

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.