mentat/hyper/client/struct.HttpConnector.html
2018-08-22 17:04:13 +00:00

169 lines
No EOL
16 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `HttpConnector` struct in crate `hyper`.">
<meta name="keywords" content="rust, rustlang, rust-lang, HttpConnector">
<title>hyper::client::HttpConnector - 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 HttpConnector</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.new_with_executor">new_with_executor</a><a href="#method.enforce_http">enforce_http</a><a href="#method.set_keepalive">set_keepalive</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Service">Service</a></div></div><p class='location'><a href='../index.html'>hyper</a>::<wbr><a href='index.html'>client</a></p><script>window.sidebarCurrent = {name: 'HttpConnector', 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=''>HttpConnector</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/connect.rs.html#49-54' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct HttpConnector { /* fields omitted */ }</pre><div class='docblock'><p>A connector for the <code>http</code> scheme.</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 <a class="struct" href="../../hyper/client/struct.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#56-101' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(threads: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, 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.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#61-67' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Construct a new HttpConnector.</p>
<p>Takes number of DNS worker threads.</p>
</div><h4 id='method.new_with_executor' class="method"><span id='new_with_executor.v' class='invisible'><code>pub fn <a href='#method.new_with_executor' class='fnname'>new_with_executor</a>&lt;E:&nbsp;'static&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;executor: E, <br>&nbsp;&nbsp;&nbsp;&nbsp;handle: &amp;<a class="struct" href="../../tokio_core/reactor/struct.Handle.html" title="struct tokio_core::reactor::Handle">Handle</a><br>) -&gt; <a class="struct" href="../../hyper/client/struct.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a> <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;HttpConnectorBlockingTask&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#73-82' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Construct a new HttpConnector.</p>
<p>Takes an executor to run blocking tasks on.</p>
</div><h4 id='method.enforce_http' class="method"><span id='enforce_http.v' class='invisible'><code>pub fn <a href='#method.enforce_http' class='fnname'>enforce_http</a>(&amp;mut self, is_enforced: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#88-90' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Option to enforce all <code>Uri</code>s have the <code>http</code> scheme.</p>
<p>Enabled by default.</p>
</div><h4 id='method.set_keepalive' class="method"><span id='set_keepalive.v' class='invisible'><code>pub fn <a href='#method.set_keepalive' class='fnname'>set_keepalive</a>(&amp;mut self, dur: <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;)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#98-100' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set that all sockets have <code>SO_KEEPALIVE</code> set with the supplied duration.</p>
<p>If <code>None</code>, the option will not be set.</p>
<p>Default is <code>None</code>.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <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.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a></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/connect.rs.html#48' 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.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#48' 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><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <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.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a></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/connect.rs.html#103-109' 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/connect.rs.html#105-108' 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-Service' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../hyper/server/trait.Service.html" title="trait hyper::server::Service">Service</a> for <a class="struct" href="../../hyper/client/struct.HttpConnector.html" title="struct hyper::client::HttpConnector">HttpConnector</a></code><a href='#impl-Service' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#111-146' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.Request' class="type"><span id='Request.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Request' class="type">Request</a> = <a class="struct" href="../../hyper/struct.Uri.html" title="struct hyper::Uri">Uri</a></code></span></h4>
<div class='docblock'><p>Requests handled by the service.</p>
</div><h4 id='associatedtype.Response' class="type"><span id='Response.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Response' class="type">Response</a> = <a class="struct" href="../../tokio_core/net/tcp/struct.TcpStream.html" title="struct tokio_core::net::tcp::TcpStream">TcpStream</a></code></span></h4>
<div class='docblock'><p>Responses given by the service.</p>
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Error' class="type">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a></code></span></h4>
<div class='docblock'><p>Errors produced by the service.</p>
</div><h4 id='associatedtype.Future' class="type"><span id='Future.t' class='invisible'><code>type <a href='../../hyper/server/trait.Service.html#associatedtype.Future' class="type">Future</a> = HttpConnecting</code></span></h4>
<div class='docblock'><p>The future response value.</p>
</div><h4 id='method.call' class="method"><span id='call.v' class='invisible'><code>fn <a href='../../hyper/server/trait.Service.html#tymethod.call' class='fnname'>call</a>(&amp;self, uri: <a class="struct" href="../../hyper/struct.Uri.html" title="struct hyper::Uri">Uri</a>) -&gt; Self::<a class="type" href="../../hyper/server/trait.Service.html#associatedtype.Future" title="type hyper::server::Service::Future">Future</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/hyper/client/connect.rs.html#117-145' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Process the request and return the response asynchronously.</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>