164 lines
12 KiB
HTML
164 lines
12 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 `MultiplexMessage` struct in crate `tokio_proto`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, MultiplexMessage">
|
|||
|
|
|
|||
|
|
<title>tokio_proto::streaming::multiplex::advanced::MultiplexMessage - 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">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct MultiplexMessage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.id">id</a><a href="#structfield.message">message</a><a href="#structfield.solo">solo</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.error">error</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</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>::<wbr><a href='index.html'>advanced</a></p><script>window.sidebarCurrent = {name: 'MultiplexMessage', 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 href='index.html'>advanced</a>::<wbr><a class="struct" href=''>MultiplexMessage</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/advanced.rs.html#156-163' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct MultiplexMessage<T, B, E> {
|
|||
|
|
pub id: <a class="type" href="../../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>,
|
|||
|
|
pub message: <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../../../tokio_proto/streaming/enum.Message.html" title="enum tokio_proto::streaming::Message">Message</a><T, B>, E>,
|
|||
|
|
pub solo: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
|||
|
|
}</pre><div class='docblock'><p>Message used to communicate through the multiplex dispatch</p>
|
|||
|
|
</div><h2 id='fields' class='fields small-section-header'>
|
|||
|
|
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.id" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.id" class="anchor field"></a>
|
|||
|
|
<span id="id.v" class='invisible'>
|
|||
|
|
<code>id: <a class="type" href="../../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>Request ID</p>
|
|||
|
|
</div><span id="structfield.message" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.message" class="anchor field"></a>
|
|||
|
|
<span id="message.v" class='invisible'>
|
|||
|
|
<code>message: <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../../../tokio_proto/streaming/enum.Message.html" title="enum tokio_proto::streaming::Message">Message</a><T, B>, E></code>
|
|||
|
|
</span></span><div class='docblock'><p>Message</p>
|
|||
|
|
</div><span id="structfield.solo" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.solo" class="anchor field"></a>
|
|||
|
|
<span id="solo.v" class='invisible'>
|
|||
|
|
<code>solo: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>True if message has no pair (request / response)</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<T, B, E> <a class="struct" href="../../../../tokio_proto/streaming/multiplex/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><T, B, E></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/tokio_proto/streaming/multiplex/advanced.rs.html#1090-1108' 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>(id: <a class="type" href="../../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>, message: <a class="enum" href="../../../../tokio_proto/streaming/enum.Message.html" title="enum tokio_proto::streaming::Message">Message</a><T, B>) -> <a class="struct" href="../../../../tokio_proto/streaming/multiplex/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><T, B, E></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/tokio_proto/streaming/multiplex/advanced.rs.html#1092-1098' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create a new MultiplexMessage</p>
|
|||
|
|
</div><h4 id='method.error' class="method"><span id='error.v' class='invisible'><code>pub fn <a href='#method.error' class='fnname'>error</a>(id: <a class="type" href="../../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>, error: E) -> <a class="struct" href="../../../../tokio_proto/streaming/multiplex/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><T, B, E></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/tokio_proto/streaming/multiplex/advanced.rs.html#1101-1107' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create a new errored MultiplexMessage</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, E: <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/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><T, B, E></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/streaming/multiplex/advanced.rs.html#155' 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>(&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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../../src/tokio_proto/streaming/multiplex/advanced.rs.html#155' 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>⏎</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>
|