mentat/tokio_proto/pipeline/struct.Pipeline.html
2018-08-22 17:04:13 +00:00

157 lines
No EOL
14 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 `Pipeline` struct in crate `tokio_proto`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Pipeline">
<title>tokio_proto::pipeline::Pipeline - 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 Pipeline</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-BindClient%3CPipeline%2C%20T%3E">BindClient&lt;Pipeline, T&gt;</a><a href="#impl-BindServer%3CPipeline%2C%20T%3E">BindServer&lt;Pipeline, T&gt;</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>tokio_proto</a>::<wbr><a href='index.html'>pipeline</a></p><script>window.sidebarCurrent = {name: 'Pipeline', 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'>tokio_proto</a>::<wbr><a href='index.html'>pipeline</a>::<wbr><a class="struct" href=''>Pipeline</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/simple/pipeline/mod.rs.html#17' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Pipeline;</pre><div class='docblock'><p>A marker used to flag protocols as being pipelined RPC.</p>
<p>This is an implementation detail; to actually implement a protocol,
implement the <code>ClientProto</code> or <code>ServerProto</code> traits in this module.</p>
</div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-BindClient%3CPipeline%2C%20T%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;'static, P:&nbsp;<a class="trait" href="../../tokio_proto/pipeline/trait.ClientProto.html" title="trait tokio_proto::pipeline::ClientProto">ClientProto</a>&lt;T&gt;&gt; <a class="trait" href="../../tokio_proto/trait.BindClient.html" title="trait tokio_proto::BindClient">BindClient</a>&lt;<a class="struct" href="../../tokio_proto/pipeline/struct.Pipeline.html" title="struct tokio_proto::pipeline::Pipeline">Pipeline</a>, T&gt; for P</code><a href='#impl-BindClient%3CPipeline%2C%20T%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_proto/simple/pipeline/client.rs.html#53-67' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.ServiceRequest' class="type"><span id='ServiceRequest.t' class='invisible'><code>type <a href='../../tokio_proto/trait.BindClient.html#associatedtype.ServiceRequest' class="type">ServiceRequest</a> = P::<a class="type" href="../../tokio_proto/pipeline/trait.ClientProto.html#associatedtype.Request" title="type tokio_proto::pipeline::ClientProto::Request">Request</a></code></span></h4>
<div class='docblock'><p>The request type for the service.</p>
</div><h4 id='associatedtype.ServiceResponse' class="type"><span id='ServiceResponse.t' class='invisible'><code>type <a href='../../tokio_proto/trait.BindClient.html#associatedtype.ServiceResponse' class="type">ServiceResponse</a> = P::<a class="type" href="../../tokio_proto/pipeline/trait.ClientProto.html#associatedtype.Response" title="type tokio_proto::pipeline::ClientProto::Response">Response</a></code></span></h4>
<div class='docblock'><p>The response type for the service.</p>
</div><h4 id='associatedtype.ServiceError' class="type"><span id='ServiceError.t' class='invisible'><code>type <a href='../../tokio_proto/trait.BindClient.html#associatedtype.ServiceError' class="type">ServiceError</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>The error type for the service.</p>
</div><h4 id='associatedtype.BindClient' class="type"><span id='BindClient.t' class='invisible'><code>type <a href='../../tokio_proto/trait.BindClient.html#associatedtype.BindClient' class="type">BindClient</a> = <a class="struct" href="../../tokio_proto/pipeline/struct.ClientService.html" title="struct tokio_proto::pipeline::ClientService">ClientService</a>&lt;T, P&gt;</code></span></h4>
<div class='docblock'><p>The bound service.</p>
</div><h4 id='method.bind_client' class="method"><span id='bind_client.v' class='invisible'><code>fn <a href='../../tokio_proto/trait.BindClient.html#tymethod.bind_client' class='fnname'>bind_client</a>(&amp;self, handle: &amp;<a class="struct" href="../../tokio_core/reactor/struct.Handle.html" title="struct tokio_core::reactor::Handle">Handle</a>, io: T) -&gt; Self::<a class="type" href="../../tokio_proto/trait.BindClient.html#associatedtype.BindClient" title="type tokio_proto::BindClient::BindClient">BindClient</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_proto/simple/pipeline/client.rs.html#60-66' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Bind an I/O object as a service.</p>
</div></div><h3 id='impl-BindServer%3CPipeline%2C%20T%3E' class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;'static, P:&nbsp;<a class="trait" href="../../tokio_proto/pipeline/trait.ServerProto.html" title="trait tokio_proto::pipeline::ServerProto">ServerProto</a>&lt;T&gt;&gt; <a class="trait" href="../../tokio_proto/trait.BindServer.html" title="trait tokio_proto::BindServer">BindServer</a>&lt;<a class="struct" href="../../tokio_proto/pipeline/struct.Pipeline.html" title="struct tokio_proto::pipeline::Pipeline">Pipeline</a>, T&gt; for P</code><a href='#impl-BindServer%3CPipeline%2C%20T%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_proto/simple/pipeline/server.rs.html#55-69' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.ServiceRequest-1' class="type"><span id='ServiceRequest.t-1' class='invisible'><code>type <a href='../../tokio_proto/trait.BindServer.html#associatedtype.ServiceRequest' class="type">ServiceRequest</a> = P::<a class="type" href="../../tokio_proto/pipeline/trait.ServerProto.html#associatedtype.Request" title="type tokio_proto::pipeline::ServerProto::Request">Request</a></code></span></h4>
<div class='docblock'><p>The request type for the service.</p>
</div><h4 id='associatedtype.ServiceResponse-1' class="type"><span id='ServiceResponse.t-1' class='invisible'><code>type <a href='../../tokio_proto/trait.BindServer.html#associatedtype.ServiceResponse' class="type">ServiceResponse</a> = P::<a class="type" href="../../tokio_proto/pipeline/trait.ServerProto.html#associatedtype.Response" title="type tokio_proto::pipeline::ServerProto::Response">Response</a></code></span></h4>
<div class='docblock'><p>The response type for the service.</p>
</div><h4 id='associatedtype.ServiceError-1' class="type"><span id='ServiceError.t-1' class='invisible'><code>type <a href='../../tokio_proto/trait.BindServer.html#associatedtype.ServiceError' class="type">ServiceError</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>The error type for the service.</p>
</div><h4 id='method.bind_server' class="method"><span id='bind_server.v' class='invisible'><code>fn <a href='../../tokio_proto/trait.BindServer.html#tymethod.bind_server' class='fnname'>bind_server</a>&lt;S&gt;(&amp;self, handle: &amp;<a class="struct" href="../../tokio_core/reactor/struct.Handle.html" title="struct tokio_core::reactor::Handle">Handle</a>, io: T, service: S) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="../../tokio_service/trait.Service.html" title="trait tokio_service::Service">Service</a>&lt;Request = Self::<a class="type" href="../../tokio_proto/trait.BindServer.html#associatedtype.ServiceRequest" title="type tokio_proto::BindServer::ServiceRequest">ServiceRequest</a>, Response = Self::<a class="type" href="../../tokio_proto/trait.BindServer.html#associatedtype.ServiceResponse" title="type tokio_proto::BindServer::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt; + 'static,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_proto/simple/pipeline/server.rs.html#60-68' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Bind the service. <a href="../../tokio_proto/trait.BindServer.html#tymethod.bind_server">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="../../tokio_proto/pipeline/struct.Pipeline.html" title="struct tokio_proto::pipeline::Pipeline">Pipeline</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/tokio_proto/simple/pipeline/mod.rs.html#16' 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, __arg_0: &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/tokio_proto/simple/pipeline/mod.rs.html#16' 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></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>