| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A builder to configure an HTTP connection."><meta name="keywords" content="rust, rustlang, rust-lang, Builder"><title>Builder in hyper::client::conn - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Builder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.executor">executor</a></li><li><a href="#method.handshake">handshake</a></li><li><a href="#method.http09_responses">http09_responses</a></li><li><a href="#method.http1_allow_obsolete_multiline_headers_in_responses">http1_allow_obsolete_multiline_headers_in_responses</a></li><li><a href="#method.http1_allow_spaces_after_header_name_in_responses">http1_allow_spaces_after_header_name_in_responses</a></li><li><a href="#method.http1_ignore_invalid_headers_in_responses">http1_ignore_invalid_headers_in_responses</a></li><li><a href="#method.http1_max_buf_size">http1_max_buf_size</a></li><li><a href="#method.http1_preserve_header_case">http1_preserve_header_case</a></li><li><a href="#method.http1_read_buf_exact_size">http1_read_buf_exact_size</a></li><li><a href="#method.http1_title_case_headers">http1_title_case_headers</a></li><li><a href="#method.http1_writev">http1_writev</a></li><li><a href="#method.http2_adaptive_window">http2_adaptive_window</a></li><li><a href="#method.http2_initial_connection_window_size">http2_initial_connection_window_size</a></li><li><a href="#method.http2_initial_stream_window_size">http2_initial_stream_window_size</a></li><li><a href="#method.http2_keep_alive_interval">http2_keep_alive_interval</a></li><li><a href="#method.http2_keep_alive_timeout">http2_keep_alive_timeout</a></li><li><a href="#method.http2_keep_alive_while_idle">http2_keep_alive_while_idle</a></li><li><a href="#method.http2_max_concurrent_reset_streams">http2_max_concurrent_reset_streams</a></li><li><a href="#method.http2_max_frame_size">http2_max_frame_size</a></li><li><a href="#method.http2_max_send_buf_size">http2_max_send_buf_size</a></li><li><a href="#method.http2_only">http2_only</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Builder">Clone</a></li><li><a href="#impl-Debug-for-Builder">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Builder">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Builder">Send</a></li><li><a href="#impl-Sync-for-Builder">Sync</a></li><li><a href="#impl-Unpin-for-Builder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Builder">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Builder">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Builder">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Builder">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Builder">From<T></a></li><li><a href="#impl-Instrument-for-Builder">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-Builder">Into<U></a></li><li><a href="#impl-ToOwned-for-Builder">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Builder">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Builder">TryInto<U></a></li><li><a href="#impl-WithSubscriber-for-Builder">WithSubscriber</a></li></ul></section><h2><a href="index.html">In hyper::client::conn</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../../index.html">hyper</a>::<wbr><a href="../index.html">client</a>::<wbr><a href="index.html">conn</a>::<wbr><a class="struct" href="#">Builder</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/hyper/client/conn.rs.html#183-199">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Builder { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A builder to configure an HTTP connection.</p> |
| <p>After setting options, the builder is used to create a handshake future.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#590-1066">source</a><a href="#impl-Builder" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#593-614">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Creates a new connection builder.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.executor" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#617-623">source</a><h4 class="code-header">pub fn <a href="#method.executor" class="fnname">executor</a><E>(&mut self, exec: E) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a><span class="where fmt-newline">where<br> E: <a class="trait" href="../../rt/trait.Executor.html" title="trait hyper::rt::Executor">Executor</a><Pin<Box<dyn Future<Output = ()> + Send>>> + Send + Sync + 'static,</span></h4></section></summary><div class="docblock"><p>Provide an executor to execute background HTTP2 tasks.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http09_responses" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#628-631">source</a><h4 class="code-header">pub fn <a href="#method.http09_responses" class="fnname">http09_responses</a>(&mut self, enabled: bool) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set whether HTTP/0.9 responses should be tolerated.</p> |
| <p>Default is false.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_allow_spaces_after_header_name_in_responses" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#652-659">source</a><h4 class="code-header">pub fn <a href="#method.http1_allow_spaces_after_header_name_in_responses" class="fnname">http1_allow_spaces_after_header_name_in_responses</a>(<br> &mut self,<br> enabled: bool<br>) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set whether HTTP/1 connections will accept spaces between header names |
| and the colon that follow them in responses.</p> |
| <p>You probably don’t need this, here is what <a href="https://tools.ietf.org/html/rfc7230#section-3.2.4">RFC 7230 Section 3.2.4.</a> has |
| to say about it:</p> |
| <blockquote> |
| <p>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.</p> |
| </blockquote> |
| <p>Note that this setting does not affect HTTP/2.</p> |
| <p>Default is false.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_allow_obsolete_multiline_headers_in_responses" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#695-702">source</a><h4 class="code-header">pub fn <a href="#method.http1_allow_obsolete_multiline_headers_in_responses" class="fnname">http1_allow_obsolete_multiline_headers_in_responses</a>(<br> &mut self,<br> enabled: bool<br>) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set whether HTTP/1 connections will accept obsolete line folding for |
| header values.</p> |
| <p>Newline codepoints (<code>\r</code> and <code>\n</code>) will be transformed to spaces when |
| parsing.</p> |
| <p>You probably don’t need this, here is what <a href="https://tools.ietf.org/html/rfc7230#section-3.2.4">RFC 7230 Section 3.2.4.</a> has |
| to say about it:</p> |
| <blockquote> |
| <p>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.</p> |
| </blockquote> |
| <blockquote> |
| <p>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.</p> |
| </blockquote> |
| <blockquote> |
| <p>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.</p> |
| </blockquote> |
| <p>Note that this setting does not affect HTTP/2.</p> |
| <p>Default is false.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_ignore_invalid_headers_in_responses" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#713-720">source</a><h4 class="code-header">pub fn <a href="#method.http1_ignore_invalid_headers_in_responses" class="fnname">http1_ignore_invalid_headers_in_responses</a>(<br> &mut self,<br> enabled: bool<br>) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set whether HTTP/1 connections will silently ignored malformed header lines.</p> |
| <p>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.</p> |
| <p>Note that this setting does not affect HTTP/2.</p> |
| <p>Default is false.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_writev" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#734-737">source</a><h4 class="code-header">pub fn <a href="#method.http1_writev" class="fnname">http1_writev</a>(&mut self, enabled: bool) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set whether HTTP/1 connections should try to use vectored writes, |
| or always flatten into a single buffer.</p> |
| <p>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.</p> |
| <p>Setting this to true will force hyper to use queued strategy |
| which may eliminate unnecessary cloning on some TLS backends</p> |
| <p>Default is <code>auto</code>. In this mode hyper will try to guess which |
| mode to use</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_title_case_headers" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#745-748">source</a><h4 class="code-header">pub fn <a href="#method.http1_title_case_headers" class="fnname">http1_title_case_headers</a>(&mut self, enabled: bool) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set whether HTTP/1 connections will write header names as title case at |
| the socket level.</p> |
| <p>Note that this setting does not affect HTTP/2.</p> |
| <p>Default is false.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_preserve_header_case" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#763-766">source</a><h4 class="code-header">pub fn <a href="#method.http1_preserve_header_case" class="fnname">http1_preserve_header_case</a>(&mut self, enabled: bool) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Set whether to support preserving original header cases.</p> |
| <p>Currently, this will record the original cases received, and store them |
| in a private extension on the <code>Response</code>. It will also look for and use |
| such an extension in any provided <code>Request</code>.</p> |
| <p>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.</p> |
| <p>Note that this setting does not affect HTTP/2.</p> |
| <p>Default is false.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_read_buf_exact_size" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#788-792">source</a><h4 class="code-header">pub fn <a href="#method.http1_read_buf_exact_size" class="fnname">http1_read_buf_exact_size</a>(&mut self, sz: Option<usize>) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Sets the exact size of the read buffer to <em>always</em> use.</p> |
| <p>Note that setting this option unsets the <code>http1_max_buf_size</code> option.</p> |
| <p>Default is an adaptive read buffer.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http1_max_buf_size" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#805-814">source</a><h4 class="code-header">pub fn <a href="#method.http1_max_buf_size" class="fnname">http1_max_buf_size</a>(&mut self, max: usize) -> &mut Self</h4></section></summary><div class="docblock"><p>Set the maximum buffer size for the connection.</p> |
| <p>Default is ~400kb.</p> |
| <p>Note that setting this option unsets the <code>http1_read_exact_buf_size</code> option.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>The minimum value allowed is 8192. This method panics if the passed <code>max</code> is less than the minimum.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_only" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#827-832">source</a><h4 class="code-header">pub fn <a href="#method.http2_only" class="fnname">http2_only</a>(&mut self, enabled: bool) -> &mut <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Sets whether HTTP2 is required.</p> |
| <p>Default is false.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_initial_stream_window_size" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#844-850">source</a><h4 class="code-header">pub fn <a href="#method.http2_initial_stream_window_size" class="fnname">http2_initial_stream_window_size</a>(<br> &mut self,<br> sz: impl Into<Option<u32>><br>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the <a href="https://http2.github.io/http2-spec/#SETTINGS_INITIAL_WINDOW_SIZE"><code>SETTINGS_INITIAL_WINDOW_SIZE</code></a> option for HTTP2 |
| stream-level flow control.</p> |
| <p>Passing <code>None</code> will do nothing.</p> |
| <p>If not set, hyper will use a default.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_initial_connection_window_size" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#859-868">source</a><h4 class="code-header">pub fn <a href="#method.http2_initial_connection_window_size" class="fnname">http2_initial_connection_window_size</a>(<br> &mut self,<br> sz: impl Into<Option<u32>><br>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the max connection-level flow control for HTTP2</p> |
| <p>Passing <code>None</code> will do nothing.</p> |
| <p>If not set, hyper will use a default.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_adaptive_window" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#877-886">source</a><h4 class="code-header">pub fn <a href="#method.http2_adaptive_window" class="fnname">http2_adaptive_window</a>(&mut self, enabled: bool) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets whether to use an adaptive flow control.</p> |
| <p>Enabling this will override the limits set in |
| <code>http2_initial_stream_window_size</code> and |
| <code>http2_initial_connection_window_size</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_max_frame_size" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#895-900">source</a><h4 class="code-header">pub fn <a href="#method.http2_max_frame_size" class="fnname">http2_max_frame_size</a>(&mut self, sz: impl Into<Option<u32>>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the maximum frame size to use for HTTP2.</p> |
| <p>Passing <code>None</code> will do nothing.</p> |
| <p>If not set, hyper will use a default.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_keep_alive_interval" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#915-921">source</a><h4 class="code-header">pub fn <a href="#method.http2_keep_alive_interval" class="fnname">http2_keep_alive_interval</a>(<br> &mut self,<br> interval: impl Into<Option<Duration>><br>) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets an interval for HTTP2 Ping frames should be sent to keep a |
| connection alive.</p> |
| <p>Pass <code>None</code> to disable HTTP2 keep-alive.</p> |
| <p>Default is currently disabled.</p> |
| <h5 id="cargo-feature"><a href="#cargo-feature">Cargo Feature</a></h5> |
| <p>Requires the <code>runtime</code> cargo feature to be enabled.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_keep_alive_timeout" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#936-939">source</a><h4 class="code-header">pub fn <a href="#method.http2_keep_alive_timeout" class="fnname">http2_keep_alive_timeout</a>(&mut self, timeout: Duration) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets a timeout for receiving an acknowledgement of the keep-alive ping.</p> |
| <p>If the ping is not acknowledged within the timeout, the connection will |
| be closed. Does nothing if <code>http2_keep_alive_interval</code> is disabled.</p> |
| <p>Default is 20 seconds.</p> |
| <h5 id="cargo-feature-1"><a href="#cargo-feature-1">Cargo Feature</a></h5> |
| <p>Requires the <code>runtime</code> cargo feature to be enabled.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_keep_alive_while_idle" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#956-959">source</a><h4 class="code-header">pub fn <a href="#method.http2_keep_alive_while_idle" class="fnname">http2_keep_alive_while_idle</a>(&mut self, enabled: bool) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets whether HTTP2 keep-alive should apply while the connection is idle.</p> |
| <p>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 <code>http2_keep_alive_interval</code> is |
| disabled.</p> |
| <p>Default is <code>false</code>.</p> |
| <h5 id="cargo-feature-2"><a href="#cargo-feature-2">Cargo Feature</a></h5> |
| <p>Requires the <code>runtime</code> cargo feature to be enabled.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_max_concurrent_reset_streams" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#971-974">source</a><h4 class="code-header">pub fn <a href="#method.http2_max_concurrent_reset_streams" class="fnname">http2_max_concurrent_reset_streams</a>(&mut self, max: usize) -> &mut Self</h4></section></summary><div class="docblock"><p>Sets the maximum number of HTTP2 concurrent locally reset streams.</p> |
| <p>See the documentation of <a href="https://docs.rs/h2/client/struct.Builder.html#method.max_concurrent_reset_streams"><code>h2::client::Builder::max_concurrent_reset_streams</code></a> for more |
| details.</p> |
| <p>The default value is determined by the <code>h2</code> crate.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.http2_max_send_buf_size" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#985-989">source</a><h4 class="code-header">pub fn <a href="#method.http2_max_send_buf_size" class="fnname">http2_max_send_buf_size</a>(&mut self, max: usize) -> &mut Self</h4></section></summary><div class="docblock"><p>Set the maximum write buffer size for each HTTP/2 stream.</p> |
| <p>Default is currently 1MB, but may change.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>The value must be no larger than <code>u32::MAX</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.handshake" class="method has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#996-1065">source</a><h4 class="code-header">pub fn <a href="#method.handshake" class="fnname">handshake</a><T, B>(<br> &self,<br> io: T<br>) -> impl Future<Output = <a class="type" href="../../type.Result.html" title="type hyper::Result">Result</a><(<a class="struct" href="struct.SendRequest.html" title="struct hyper::client::conn::SendRequest">SendRequest</a><B>, <a class="struct" href="struct.Connection.html" title="struct hyper::client::conn::Connection">Connection</a><T, B>)>><span class="where fmt-newline">where<br> T: <a class="trait" href="../../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a> + <a class="trait" href="../../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a> + Unpin + Send + 'static,<br> B: <a class="trait" href="../../body/trait.HttpBody.html" title="trait hyper::body::HttpBody">HttpBody</a> + 'static,<br> B::<a class="associatedtype" href="../../body/trait.HttpBody.html#associatedtype.Data" title="type hyper::body::HttpBody::Data">Data</a>: Send,<br> B::<a class="associatedtype" href="../../body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>: Into<Box<dyn StdError + Send + Sync>>,</span></h4></section></summary><div class="docblock"><p>Constructs a connection with the configured options and IO. |
| See <a href="index.html"><code>client::conn</code></a> for more.</p> |
| <p>Note, if <a href="struct.Connection.html" title="Connection"><code>Connection</code></a> is not <code>await</code>-ed, <a href="struct.SendRequest.html" title="SendRequest"><code>SendRequest</code></a> will |
| do nothing.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#176">source</a><a href="#impl-Clone-for-Builder" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#176">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#176">source</a><a href="#impl-Debug-for-Builder" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/hyper/client/conn.rs.html#176">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Builder" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Builder" class="anchor"></a><h3 class="code-header">impl !RefUnwindSafe for <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section><section id="impl-Send-for-Builder" class="impl has-srclink"><a href="#impl-Send-for-Builder" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section><section id="impl-Sync-for-Builder" class="impl has-srclink"><a href="#impl-Sync-for-Builder" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section><section id="impl-Unpin-for-Builder" class="impl has-srclink"><a href="#impl-Unpin-for-Builder" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section><section id="impl-UnwindSafe-for-Builder" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Builder" class="anchor"></a><h3 class="code-header">impl !UnwindSafe for <a class="struct" href="struct.Builder.html" title="struct hyper::client::conn::Builder">Builder</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Builder" class="impl has-srclink"><a href="#impl-Any-for-Builder" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Instrument-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#276">source</a><a href="#impl-Instrument-for-Builder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#82">source</a><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="../../../tracing/span/struct.Span.html" title="Span"><code>Span</code></a>, returning an |
| <code>Instrumented</code> wrapper. <a href="../../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#121">source</a><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><div class='docblock'>Instruments this type with the <a href="../../../tracing/span/struct.Span.html#method.current">current</a> <a href="../../../tracing/span/struct.Span.html"><code>Span</code></a>, returning an |
| <code>Instrumented</code> wrapper. <a href="../../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Builder" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Builder" class="impl has-srclink"><a href="#impl-ToOwned-for-Builder" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Builder" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Builder" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#334">source</a><a href="#impl-WithSubscriber-for-Builder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="../../../tracing/instrument/trait.WithSubscriber.html" title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#169-171">source</a><a href="#method.with_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber" class="fnname">with_subscriber</a><S>(self, subscriber: S) -> <a class="struct" href="../../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self><span class="where fmt-newline">where<br> S: Into<<a class="struct" href="../../../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>>,</span></h4></section></summary><div class='docblock'>Attaches the provided <a href="../../../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a |
| <a href="../../../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#221">source</a><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -> <a class="struct" href="../../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><div class='docblock'>Attaches the current <a href="../../../tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="../../../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a |
| <a href="../../../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
