mentat/tokio_proto/util/client_proxy/index.html
2018-08-22 17:04:13 +00:00

176 lines
No EOL
7.8 KiB
HTML
Raw 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 `client_proxy` mod in crate `tokio_proto`.">
<meta name="keywords" content="rust, rustlang, rust-lang, client_proxy">
<title>tokio_proto::util::client_proxy - 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 mod">
<!--[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'>Module client_proxy</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../../index.html'>tokio_proto</a>::<wbr><a href='../index.html'>util</a></p><script>window.sidebarCurrent = {name: 'client_proxy', ty: 'mod', 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'>Module <a href='../../index.html'>tokio_proto</a>::<wbr><a href='../index.html'>util</a>::<wbr><a class="mod" href=''>client_proxy</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/tokio_proto/util/client_proxy.rs.html#1-119' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Utilities for building protocol clients</p>
<p>Provides a channel that handles details of providing a <code>Service</code> client.
Usually, this module does not have to be used directly. Instead it is used
by <code>pipeline</code> and <code>multiplex</code> in the <code>connect</code> fns.</p>
<p>However, some protocols require implementing the dispatch layer directly,
in which case using client channel is helpful.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.ClientProxy.html"
title='struct tokio_proto::util::client_proxy::ClientProxy'>ClientProxy</a></td>
<td class='docblock-short'>
<p>Client <code>Service</code> for pipeline or multiplex protocols</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Response.html"
title='struct tokio_proto::util::client_proxy::Response'>Response</a></td>
<td class='docblock-short'>
<p>Response future returned from a client</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.pair.html"
title='fn tokio_proto::util::client_proxy::pair'>pair</a></td>
<td class='docblock-short'>
<p>Return a client handle and a handle used to receive requests on</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.Pair.html"
title='type tokio_proto::util::client_proxy::Pair'>Pair</a></td>
<td class='docblock-short'>
<p>A client / receiver pair</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.Receiver.html"
title='type tokio_proto::util::client_proxy::Receiver'>Receiver</a></td>
<td class='docblock-short'>
<p>Receive requests submitted to the client</p>
</td>
</tr></table></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 = "tokio_proto";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>