130 lines
8.7 KiB
HTML
130 lines
8.7 KiB
HTML
|
<!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 `Pool` struct in crate `hyper`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Pool">
|
|||
|
|
|
|||
|
|
<title>hyper::client::pool::Pool - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
|
|||
|
|
<p class='location'><a href='../../index.html'>hyper</a>::<wbr><a href='../index.html'>client</a>::<wbr><a href='index.html'>pool</a></p><script>window.sidebarCurrent = {name: 'Pool', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<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 struct">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>hyper</a>::<wbr><a href='../index.html'>client</a>::<wbr><a href='index.html'>pool</a>::<wbr><a class='struct' href=''>Pool</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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a id='src-265' class='srclink' href='../../../src/hyper/client/pool.rs.html#14-17' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Pool<C: <a class='trait' href='../../../hyper/net/trait.NetworkConnector.html' title='hyper::net::NetworkConnector'>NetworkConnector</a>> {
|
|||
|
|
// some fields omitted
|
|||
|
|
}</pre><div class='docblock'><p>The <code>NetworkConnector</code> that behaves as a connection pool used by hyper's <code>Client</code>.</p>
|
|||
|
|
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='struct' href='../../../hyper/client/pool/struct.Pool.html' title='hyper::client::pool::Pool'>Pool</a><DefaultConnector></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-344' class='srclink' href='../../../src/hyper/client/pool.rs.html#64-70' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>(config: <a class='struct' href='../../../hyper/client/pool/struct.Config.html' title='hyper::client::pool::Config'>Config</a>) -> <a class='struct' href='../../../hyper/client/pool/struct.Pool.html' title='hyper::client::pool::Pool'>Pool</a><DefaultConnector></code></h4>
|
|||
|
|
<div class='docblock'><p>Creates a <code>Pool</code> with a <code>DefaultConnector</code>.</p>
|
|||
|
|
</div></div><h3 class='impl'><span class='in-band'><code>impl<C: <a class='trait' href='../../../hyper/net/trait.NetworkConnector.html' title='hyper::net::NetworkConnector'>NetworkConnector</a>> <a class='struct' href='../../../hyper/client/pool/struct.Pool.html' title='hyper::client::pool::Pool'>Pool</a><C></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-347' class='srclink' href='../../../src/hyper/client/pool.rs.html#72-90' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.with_connector' class='method'><code>fn <a href='#method.with_connector' class='fnname'>with_connector</a>(config: <a class='struct' href='../../../hyper/client/pool/struct.Config.html' title='hyper::client::pool::Config'>Config</a>, connector: C) -> <a class='struct' href='../../../hyper/client/pool/struct.Pool.html' title='hyper::client::pool::Pool'>Pool</a><C></code></h4>
|
|||
|
|
<div class='docblock'><p>Creates a <code>Pool</code> with a specified <code>NetworkConnector</code>.</p>
|
|||
|
|
</div><h4 id='method.clear_idle' class='method'><code>fn <a href='#method.clear_idle' class='fnname'>clear_idle</a>(&mut self)</code></h4>
|
|||
|
|
<div class='docblock'><p>Clear all idle connections from the Pool, closing them.</p>
|
|||
|
|
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<C: <a class='trait' href='../../../hyper/net/trait.NetworkConnector.html' title='hyper::net::NetworkConnector'>NetworkConnector</a><Stream=S>, S: <a class='trait' href='../../../hyper/net/trait.NetworkStream.html' title='hyper::net::NetworkStream'>NetworkStream</a> + <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Send.html' title='core::marker::Send'>Send</a>> <a class='trait' href='../../../hyper/net/trait.NetworkConnector.html' title='hyper::net::NetworkConnector'>NetworkConnector</a> for <a class='struct' href='../../../hyper/client/pool/struct.Pool.html' title='hyper::client::pool::Pool'>Pool</a><C></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-365' class='srclink' href='../../../src/hyper/client/pool.rs.html#102-137' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Stream' class='type'><code>type <a href='../../../hyper/net/trait.NetworkConnector.html#associatedtype.Stream' class='type'>Stream</a> = <a class='struct' href='../../../hyper/client/pool/struct.PooledStream.html' title='hyper::client::pool::PooledStream'>PooledStream</a><S></code></h4>
|
|||
|
|
<div class='docblock'><p>Type of <code>Stream</code> to create</p>
|
|||
|
|
</div><h4 id='method.connect' class='method'><code>fn <a href='../../../hyper/net/trait.NetworkConnector.html#tymethod.connect' class='fnname'>connect</a>(&self, host: &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, port: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u16.html'>u16</a>, scheme: &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> <a class='type' href='../../../hyper/error/type.Result.html' title='hyper::error::Result'>Result</a><<a class='struct' href='../../../hyper/client/pool/struct.PooledStream.html' title='hyper::client::pool::PooledStream'>PooledStream</a><S>></code></h4>
|
|||
|
|
<div class='docblock'><p>Connect to a remote address.</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>?</dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt>S</dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt>+</dt>
|
|||
|
|
<dd>Collapse/expand 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";
|
|||
|
|
window.playgroundUrl = "";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../../jquery.js"></script>
|
|||
|
|
<script src="../../../main.js"></script>
|
|||
|
|
|
|||
|
|
<script defer src="../../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|