mentat/hyper/client/struct.Config.html

194 lines
23 KiB
HTML
Raw Normal View History

2018-08-22 17:04:13 +00:00
<!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="API documentation for the Rust `Config` struct in crate `hyper`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Config">
<title>hyper::client::Config - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Struct Config</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.body">body</a><a href="#method.connector">connector</a><a href="#method.keep_alive">keep_alive</a><a href="#method.keep_alive_timeout">keep_alive_timeout</a><a href="#method.http1_writev">http1_writev</a><a href="#method.retry_canceled_requests">retry_canceled_requests</a><a href="#method.set_host">set_host</a><a href="#method.build">build</a><a href="#method.executor">executor</a><a href="#method.build">build</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Default">Default</a><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a></div></div><p class='location'><a href='../index.html'>hyper</a>::<wbr><a href='index.html'>client</a></p><script>window.sidebarCurrent = {name: 'Config', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>hyper</a>::<wbr><a href='index.html'>client</a>::<wbr><a class="struct" href=''>Config</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/hyper/client/mod.rs.html#421-432' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Config&lt;C, B&gt; { /* fields omitted */ }</pre><div class='docblock'><p>Configuration for a Client</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;C, B&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#453-560' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.body' class="method"><span id='body.v' class='invisible'><code>pub fn <a href='#method.body' class='fnname'>body</a>&lt;BB&gt;(self) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, BB&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#464-475' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set the body stream to be used by the <code>Client</code>.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="ident">cfg</span> <span class="op">=</span> <span class="ident">Config</span>::<span class="ident">default</span>()
.<span class="ident">body</span>::<span class="op">&lt;</span><span class="ident">hyper</span>::<span class="ident">Body</span><span class="op">&gt;</span>();</pre>
</div><h4 id='method.connector' class="method"><span id='connector.v' class='invisible'><code>pub fn <a href='#method.connector' class='fnname'>connector</a>&lt;CC&gt;(self, val: CC) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;CC, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#479-490' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set the <code>Connect</code> type to be used.</p>
</div><h4 id='method.keep_alive' class="method"><span id='keep_alive.v' class='invisible'><code>pub fn <a href='#method.keep_alive' class='fnname'>keep_alive</a>(self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#496-499' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Enable or disable keep-alive mechanics.</p>
<p>Default is enabled.</p>
</div><h4 id='method.keep_alive_timeout' class="method"><span id='keep_alive_timeout.v' class='invisible'><code>pub fn <a href='#method.keep_alive_timeout' class='fnname'>keep_alive_timeout</a>(self, val: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>&gt;) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#507-510' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set an optional timeout for idle sockets being kept-alive.</p>
<p>Pass <code>None</code> to disable timeout.</p>
<p>Default is 90 seconds.</p>
</div><h4 id='method.http1_writev' class="method"><span id='http1_writev.v' class='invisible'><code>pub fn <a href='#method.http1_writev' class='fnname'>http1_writev</a>(self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#521-524' title='goto source code'>[src]</a></span></h4>
<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>Default is <code>true</code>.</p>
</div><h4 id='method.retry_canceled_requests' class="method"><span id='retry_canceled_requests.v' class='invisible'><code>pub fn <a href='#method.retry_canceled_requests' class='fnname'>retry_canceled_requests</a>(self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#538-541' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set whether to retry requests that get disrupted before ever starting
to write.</p>
<p>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.</p>
<p>When this is set to <code>false</code>, the related <code>FutureResponse</code> would instead
resolve to an <code>Error::Cancel</code>.</p>
<p>Default is <code>true</code>.</p>
</div><h4 id='method.set_host' class="method"><span id='set_host.v' class='invisible'><code>pub fn <a href='#method.set_host' class='fnname'>set_host</a>(self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#550-553' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set whether to automatically add the <code>Host</code> header to requests.</p>
<p>If true, and a request does not include a <code>Host</code> header, one will be
added automatically, derived from the authority of the <code>Uri</code>.</p>
<p>Default is <code>true</code>.</p>
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl&lt;C, B&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;C: <a class="trait" href="../../hyper/client/trait.Connect.html" title="trait hyper::client::Connect">Connect</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>&lt;Error = <a class="enum" href="../../hyper/error/enum.Error.html" title="enum hyper::error::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;B::<a class="type" href="../../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt;,&nbsp;</span></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#562-583' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.build' class="method"><span id='build.v' class='invisible'><code>pub fn <a href='#method.build' class='fnname'>build</a>(self, handle: &amp;<a class="struct" href="../../tokio_core/reactor/struct.Handle.html" title="struct tokio_core::reactor::Handle">Handle</a>) -&gt; <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a>&lt;C, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#569-571' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Construct the Client with this configuration.</p>
</div><h4 id='method.executor' class="method"><span id='executor.v' class='invisible'><code>pub fn <a href='#method.executor' class='fnname'>executor</a>&lt;E&gt;(self, executor: E) -&gt; <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a>&lt;C, B&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="../../futures/future/trait.Executor.html" title="trait futures::future::Executor">Executor</a>&lt;Background&gt; + 'static,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#577-582' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Construct a Client with this configuration and an executor.</p>
<p>The executor will be used to spawn &quot;background&quot; connection tasks
to drive requests and responses.</p>
</div></div><h3 id='impl-2' class='impl'><span class='in-band'><code>impl&lt;B&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;<a class="struct" href="../../hyper/client/struct.UseDefaultConnector.html" title="struct hyper::client::UseDefaultConnector">UseDefaultConnector</a>, B&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>&lt;Error = <a class="enum" href="../../hyper/error/enum.Error.html" title="enum hyper::error::Error">Error</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;B::<a class="type" href="../../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt;,&nbsp;</span></code><a href='#impl-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#585-598' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.build-1' class="method"><span id='build.v-1' class='invisible'><code>pub fn <a href='#method.build-1' class='fnname'>build</a>(self, handle: &amp;<a class="struct" href="../../tokio_core/reactor/struct.Handle.html" title="struct tokio_core::reactor::Handle">Handle</a>) -&gt; <a class="struct" href="../../hyper/client/struct.Client.html" title="struct hyper::client::Client">Client</a>&lt;<a class="struct" href="../../hyper/client/struct.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a>, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#591-597' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Construct the Client with this configuration.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Default' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;<a class="struct" href="../../hyper/client/struct.UseDefaultConnector.html" title="struct hyper::client::UseDefaultConnector">UseDefaultConnector</a>, <a class="struct" href="../../hyper/struct.Body.html" title="struct hyper::Body">Body</a>&gt;</code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#438-451' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;<a class="struct" href="../../hyper/client/struct.UseDefaultConnector.html" title="struct hyper::client::UseDefaultConnector">UseDefaultConnector</a>, <a class="struct" href="../../hyper/struct.Body.html" title="struct hyper::Body">Body</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#439-450' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;C, B&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#600-610' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#601-609' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl&lt;C:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, B&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#612-619' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../hyper/client/struct.Config.html" title="struct hyper::client::Config">Config</a>&lt;C, B&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/mod.rs.html#613-618' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "hyper";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>