156 lines
21 KiB
HTML
156 lines
21 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 `StreamingMultiplex` struct in crate `tokio_proto`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, StreamingMultiplex">
|
|||
|
|
|
|||
|
|
<title>tokio_proto::streaming::multiplex::StreamingMultiplex - 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="../../../light.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">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct StreamingMultiplex</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%3CStreamingMultiplex%3CB%3E%2C%20T%3E">BindClient<StreamingMultiplex<B>, T></a><a href="#impl-BindServer%3CStreamingMultiplex%3CB%3E%2C%20T%3E">BindServer<StreamingMultiplex<B>, T></a><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../../index.html'>tokio_proto</a>::<wbr><a href='../index.html'>streaming</a>::<wbr><a href='index.html'>multiplex</a></p><script>window.sidebarCurrent = {name: 'StreamingMultiplex', 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'>streaming</a>::<wbr><a href='index.html'>multiplex</a>::<wbr><a class="struct" href=''>StreamingMultiplex</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 class='srclink' href='../../../src/tokio_proto/streaming/multiplex/mod.rs.html#32' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct StreamingMultiplex<B>(_);</pre></div><div class='docblock'><p>A marker used to flag protocols as being streaming and multiplexed.</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>
|
|||
|
|
<div id='implementations-list'>
|
|||
|
|
<h3 id='impl-BindClient%3CStreamingMultiplex%3CB%3E%2C%20T%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<P, T, B> <a class="trait" href="../../../tokio_proto/trait.BindClient.html" title="trait tokio_proto::BindClient">BindClient</a><<a class="struct" href="../../../tokio_proto/streaming/multiplex/struct.StreamingMultiplex.html" title="struct tokio_proto::streaming::multiplex::StreamingMultiplex">StreamingMultiplex</a><B>, T> for P <span class="where fmt-newline">where<br> P: <a class="trait" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html" title="trait tokio_proto::streaming::multiplex::ClientProto">ClientProto</a><T>,<br> T: 'static,<br> B: <a class="trait" href="../../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html#associatedtype.RequestBody" title="type tokio_proto::streaming::multiplex::ClientProto::RequestBody">RequestBody</a>, Error = P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ClientProto::Error">Error</a>> + 'static, </span></code><a href='#impl-BindClient%3CStreamingMultiplex%3CB%3E%2C%20T%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/client.rs.html#53-86' title='goto source code'>[src]</a></span></td></tr></tbody></table></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> = <a class="enum" href="../../../tokio_proto/streaming/enum.Message.html" title="enum tokio_proto::streaming::Message">Message</a><P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html#associatedtype.Request" title="type tokio_proto::streaming::multiplex::ClientProto::Request">Request</a>, B></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> = <a class="enum" href="../../../tokio_proto/streaming/enum.Message.html" title="enum tokio_proto::streaming::Message">Message</a><P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html#associatedtype.Response" title="type tokio_proto::streaming::multiplex::ClientProto::Response">Response</a>, <a class="struct" href="../../../tokio_proto/streaming/struct.Body.html" title="struct tokio_proto::streaming::Body">Body</a><P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html#associatedtype.ResponseBody" title="type tokio_proto::streaming::multiplex::ClientProto::ResponseBody">ResponseBody</a>, P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ClientProto::Error">Error</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> = P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ClientProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ClientProto::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/util/client_proxy/struct.ClientProxy.html" title="struct tokio_proto::util::client_proxy::ClientProxy">ClientProxy</a><Self::<a class="type" href="../../../tokio_proto/trait.BindClient.html#associatedtype.ServiceRequest" title="type tokio_proto::BindClient::ServiceRequest">ServiceRequest</a>, Self::<a class="type" href="../../../tokio_proto/trait.BindClient.html#associatedtype.ServiceResponse" title="type tokio_proto::BindClient::ServiceResponse">ServiceResponse</a>, Self::<a class="type" href="../../../tokio_proto/trait.BindClient.html#associatedtype.ServiceError" title="type tokio_proto::BindClient::ServiceError">ServiceError</a>></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'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio_proto/trait.BindClient.html#tymethod.bind_client' class='fnname'>bind_client</a>(&self, handle: &<a class="struct" href="../../../tokio_core/reactor/struct.Handle.html" title="struct tokio_core::reactor::Handle">Handle</a>, io: T) -> Self::<a class="type" href="../../../tokio_proto/trait.BindClient.html#associatedtype.BindClient" title="type tokio_proto::BindClient::BindClient">BindClient</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/client.rs.html#64-85' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Bind an I/O object as a service.</p>
|
|||
|
|
</div></div><h3 id='impl-BindServer%3CStreamingMultiplex%3CB%3E%2C%20T%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<P, T, B> <a class="trait" href="../../../tokio_proto/trait.BindServer.html" title="trait tokio_proto::BindServer">BindServer</a><<a class="struct" href="../../../tokio_proto/streaming/multiplex/struct.StreamingMultiplex.html" title="struct tokio_proto::streaming::multiplex::StreamingMultiplex">StreamingMultiplex</a><B>, T> for P <span class="where fmt-newline">where<br> P: <a class="trait" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html" title="trait tokio_proto::streaming::multiplex::ServerProto">ServerProto</a><T>,<br> T: 'static,<br> B: <a class="trait" href="../../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.ResponseBody" title="type tokio_proto::streaming::multiplex::ServerProto::ResponseBody">ResponseBody</a>, Error = P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ServerProto::Error">Error</a>>, </span></code><a href='#impl-BindServer%3CStreamingMultiplex%3CB%3E%2C%20T%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/server.rs.html#70-96' title='goto source code'>[src]</a></span></td></tr></tbody></table></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> = <a class="enum" href="../../../tokio_proto/streaming/enum.Message.html" title="enum tokio_proto::streaming::Message">Message</a><P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Request" title="type tokio_proto::streaming::multiplex::ServerProto::Request">Request</a>, <a class="struct" href="../../../tokio_proto/streaming/struct.Body.html" title="struct tokio_proto::streaming::Body">Body</a><P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.RequestBody" title="type tokio_proto::streaming::multiplex::ServerProto::RequestBody">RequestBody</a>, P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ServerProto::Error">Error</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> = <a class="enum" href="../../../tokio_proto/streaming/enum.Message.html" title="enum tokio_proto::streaming::Message">Message</a><P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Response" title="type tokio_proto::streaming::multiplex::ServerProto::Response">Response</a>, B></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> = P::<a class="type" href="../../../tokio_proto/streaming/multiplex/trait.ServerProto.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::ServerProto::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'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio_proto/trait.BindServer.html#tymethod.bind_server' class='fnname'>bind_server</a><S>(&self, handle: &<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> S: <a class="trait" href="../../../tokio_service/trait.Service.html" title="trait tokio_service::Service">Service</a><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 = Self::<a class="type" href="../../../tokio_proto/trait.BindServer.html#associatedtype.ServiceError" title="type tokio_proto::BindServer::ServiceError">ServiceError</a>> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/server.rs.html#79-95' title='goto source code'>[src]</a></td></tr></tbody></table></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'><table class='table-display'><tbody><tr><td><code>impl<B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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/streaming/multiplex/struct.StreamingMultiplex.html" title="struct tokio_proto::streaming::multiplex::StreamingMultiplex">StreamingMultiplex</a><B></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/mod.rs.html#31' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/mod.rs.html#31' title='goto source code'>[src]</a></td></tr></tbody></table></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></div>
|
|||
|
|
<h2 id='synthetic-implementations' class='small-section-header'>
|
|||
|
|
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='synthetic-implementations-list'>
|
|||
|
|
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../tokio_proto/streaming/multiplex/struct.StreamingMultiplex.html" title="struct tokio_proto::streaming::multiplex::StreamingMultiplex">StreamingMultiplex</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../tokio_proto/streaming/multiplex/struct.StreamingMultiplex.html" title="struct tokio_proto::streaming::multiplex::StreamingMultiplex">StreamingMultiplex</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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>⏎</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>
|