190 lines
18 KiB
HTML
190 lines
18 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 `Frame` enum in crate `tokio_proto`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Frame">
|
|||
|
|
|
|||
|
|
<title>tokio_proto::streaming::multiplex::Frame - 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 enum">
|
|||
|
|
<!--[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'>Enum Frame</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Message">Message</a><a href="#variant.Body">Body</a><a href="#variant.Error">Error</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.request_id">request_id</a><a href="#method.unwrap_msg">unwrap_msg</a><a href="#method.unwrap_body">unwrap_body</a><a href="#method.unwrap_err">unwrap_err</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</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: 'Frame', ty: 'enum', 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'>Enum <a href='../../index.html'>tokio_proto</a>::<wbr><a href='../index.html'>streaming</a>::<wbr><a href='index.html'>multiplex</a>::<wbr><a class="enum" href=''>Frame</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/frame.rs.html#5-34' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust enum'>pub enum Frame<T, B, E> {
|
|||
|
|
Message {
|
|||
|
|
id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>,
|
|||
|
|
message: T,
|
|||
|
|
body: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
|||
|
|
solo: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
|||
|
|
},
|
|||
|
|
Body {
|
|||
|
|
id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>,
|
|||
|
|
chunk: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B>,
|
|||
|
|
},
|
|||
|
|
Error {
|
|||
|
|
id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>,
|
|||
|
|
error: E,
|
|||
|
|
},
|
|||
|
|
}</pre><div class='docblock'><p>A multiplexed protocol frame</p>
|
|||
|
|
</div><h2 id='variants' class='variants small-section-header'>
|
|||
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|||
|
|
<span id="variant.Message" class="variant small-section-header"><a href="#variant.Message" class="anchor field"></a><span id='Message.v' class='invisible'><code>Message</code></span></span><div class='docblock'><p>Either a request or a response.</p>
|
|||
|
|
</div><span class='docblock autohide sub-variant' id='variant.Message.fields'><h3 class='fields'>Fields of <code>Message</code></h3>
|
|||
|
|
|
|||
|
|
<table><tr><td id='variant.Message.field.id'><span id='Message.v.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></td><td><div class='docblock'><p>Message exchange identifier</p>
|
|||
|
|
</div></td></tr><tr><td id='variant.Message.field.message'><span id='Message.v.message.v' class='invisible'><code>message: T</code></span></td><td><div class='docblock'><p>The message value</p>
|
|||
|
|
</div></td></tr><tr><td id='variant.Message.field.body'><span id='Message.v.body.v' class='invisible'><code>body: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><div class='docblock'><p>Set to true when body frames will follow with the same request ID.</p>
|
|||
|
|
</div></td></tr><tr><td id='variant.Message.field.solo'><span id='Message.v.solo.v' class='invisible'><code>solo: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><div class='docblock'><p>Set to <code>true</code> when this message does not have a pair in the other
|
|||
|
|
direction</p>
|
|||
|
|
</div></td></tr></table></span><span id="variant.Body" class="variant small-section-header"><a href="#variant.Body" class="anchor field"></a><span id='Body.v' class='invisible'><code>Body</code></span></span><div class='docblock'><p>Body frame.</p>
|
|||
|
|
</div><span class='docblock autohide sub-variant' id='variant.Body.fields'><h3 class='fields'>Fields of <code>Body</code></h3>
|
|||
|
|
|
|||
|
|
<table><tr><td id='variant.Body.field.id'><span id='Body.v.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></td><td><div class='docblock'><p>Message exchange identifier</p>
|
|||
|
|
</div></td></tr><tr><td id='variant.Body.field.chunk'><span id='Body.v.chunk.v' class='invisible'><code>chunk: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B></code></span></td><td><div class='docblock'><p>Body chunk. Setting to <code>None</code> indicates that the body is done
|
|||
|
|
streaming and there will be no further body frames sent with the
|
|||
|
|
given request ID.</p>
|
|||
|
|
</div></td></tr></table></span><span id="variant.Error" class="variant small-section-header"><a href="#variant.Error" class="anchor field"></a><span id='Error.v' class='invisible'><code>Error</code></span></span><div class='docblock'><p>Error</p>
|
|||
|
|
</div><span class='docblock autohide sub-variant' id='variant.Error.fields'><h3 class='fields'>Fields of <code>Error</code></h3>
|
|||
|
|
|
|||
|
|
<table><tr><td id='variant.Error.field.id'><span id='Error.v.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></td><td><div class='docblock'><p>Message exchange identifier</p>
|
|||
|
|
</div></td></tr><tr><td id='variant.Error.field.error'><span id='Error.v.error.v' class='invisible'><code>error: E</code></span></td><td><div class='docblock'><p>Error value</p>
|
|||
|
|
</div></td></tr></table></span>
|
|||
|
|
<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="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</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/frame.rs.html#36-72' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.request_id' class="method"><span id='request_id.v' class='invisible'><code>pub fn <a href='#method.request_id' class='fnname'>request_id</a>(&self) -> <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/frame.rs.html#38-44' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Return the request ID associated with the frame.</p>
|
|||
|
|
</div><h4 id='method.unwrap_msg' class="method"><span id='unwrap_msg.v' class='invisible'><code>pub fn <a href='#method.unwrap_msg' class='fnname'>unwrap_msg</a>(self) -> T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/frame.rs.html#47-53' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Unwraps a frame, yielding the content of the <code>Message</code>.</p>
|
|||
|
|
</div><h4 id='method.unwrap_body' class="method"><span id='unwrap_body.v' class='invisible'><code>pub fn <a href='#method.unwrap_body' class='fnname'>unwrap_body</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/frame.rs.html#56-62' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Unwraps a frame, yielding the content of the <code>Body</code>.</p>
|
|||
|
|
</div><h4 id='method.unwrap_err' class="method"><span id='unwrap_err.v' class='invisible'><code>pub fn <a href='#method.unwrap_err' class='fnname'>unwrap_err</a>(self) -> E</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/frame.rs.html#65-71' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Unwraps a frame, yielding the content of the <code>Error</code>.</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="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</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/frame.rs.html#4' 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/frame.rs.html#4' 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><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><T, B, E></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/frame.rs.html#4' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><T, B, E></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_proto/streaming/multiplex/frame.rs.html#4' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">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>
|