158 lines
20 KiB
HTML
158 lines
20 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 `Transport` trait in crate `tokio_proto`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Transport">
|
|||
|
|
|
|||
|
|
<title>tokio_proto::streaming::multiplex::Transport - 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 trait">
|
|||
|
|
<!--[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'>Trait Transport</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.tick">tick</a><a href="#method.cancel">cancel</a><a href="#method.poll_write_body">poll_write_body</a><a href="#method.dispatching_body">dispatching_body</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Transport%3CReadBody%3E">Framed<T, C></a><a href="#impl-Transport%3CReadBody%3E">Framed<T, C></a></div><a class="sidebar-title" href="#implementors">Implementors</a></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: 'Transport', ty: 'trait', 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'>Trait <a href='../../index.html'>tokio_proto</a>::<wbr><a href='../index.html'>streaming</a>::<wbr><a href='index.html'>multiplex</a>::<wbr><a class="trait" href=''>Transport</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#37-67' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Transport<ReadBody>: 'static + <a class="trait" href="../../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</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>> + <a class="trait" href="../../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><SinkError = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>> {
|
|||
|
|
fn <a href='#method.tick' class='fnname'>tick</a>(&mut self) { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.cancel' class='fnname'>cancel</a>(&mut self, request_id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.poll_write_body' class='fnname'>poll_write_body</a>(&mut self, id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>) -> <a class="enum" href="../../../futures/poll/enum.Async.html" title="enum futures::poll::Async">Async</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.dispatching_body' class='fnname'>dispatching_body</a>(&mut self, id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>, body: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>ReadBody) { ... }
|
|||
|
|
}</pre></div><div class='docblock'><p>Additional transport details relevant to streaming, multiplexed protocols.</p>
|
|||
|
|
<p>All methods added in this trait have default implementations.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='provided-methods' class='small-section-header'>
|
|||
|
|
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='method.tick' class='method'><span id='tick.v' class='invisible'><code>fn <a href='#method.tick' class='fnname'>tick</a>(&mut self)</code></span></h3><div class='docblock'><p>Allow the transport to do miscellaneous work (e.g., sending ping-pong
|
|||
|
|
messages) that is not directly connected to sending or receiving frames.</p>
|
|||
|
|
<p>This method should be called every time the task using the transport is
|
|||
|
|
executing.</p>
|
|||
|
|
</div><h3 id='method.cancel' class='method'><span id='cancel.v' class='invisible'><code>fn <a href='#method.cancel' class='fnname'>cancel</a>(&mut self, request_id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></h3><div class='docblock'><p>Cancel interest in the exchange identified by RequestId</p>
|
|||
|
|
</div><h3 id='method.poll_write_body' class='method'><span id='poll_write_body.v' class='invisible'><code>fn <a href='#method.poll_write_body' class='fnname'>poll_write_body</a>(&mut self, id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>) -> <a class="enum" href="../../../futures/poll/enum.Async.html" title="enum futures::poll::Async">Async</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></h3><div class='docblock'><p>Tests to see if this I/O object may accept a body frame for the given
|
|||
|
|
request ID</p>
|
|||
|
|
</div><h3 id='method.dispatching_body' class='method'><span id='dispatching_body.v' class='invisible'><code>fn <a href='#method.dispatching_body' class='fnname'>dispatching_body</a>(&mut self, id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>, body: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>ReadBody)</code></span></h3><div class='docblock'><p>Invoked before the multiplexer dispatches the body chunk to the body
|
|||
|
|
stream.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Transport%3CReadBody%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, C, ReadBody> <a class="trait" href="../../../tokio_proto/streaming/multiplex/trait.Transport.html" title="trait tokio_proto::streaming::multiplex::Transport">Transport</a><ReadBody> for Framed<T, C> <span class="where fmt-newline">where<br> T: Io + 'static,<br> C: Codec + 'static, </span></code><a href='#impl-Transport%3CReadBody%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/mod.rs.html#69-72' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.tick-1' class="method"><span id='tick.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio_proto/streaming/multiplex/trait.Transport.html#method.tick' class='fnname'>tick</a>(&mut self)</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#46' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.cancel-1' class="method"><span id='cancel.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio_proto/streaming/multiplex/trait.Transport.html#method.cancel' class='fnname'>cancel</a>(&mut self, request_id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</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#49-52' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.poll_write_body-1' class="method"><span id='poll_write_body.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio_proto/streaming/multiplex/trait.Transport.html#method.poll_write_body' class='fnname'>poll_write_body</a>(&mut self, id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>) -> <a class="enum" href="../../../futures/poll/enum.Async.html" title="enum futures::poll::Async">Async</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</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#56-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.dispatching_body-1' class="method"><span id='dispatching_body.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio_proto/streaming/multiplex/trait.Transport.html#method.dispatching_body' class='fnname'>dispatching_body</a>(&mut self, id: <a class="type" href="../../../tokio_proto/streaming/multiplex/type.RequestId.html" title="type tokio_proto::streaming::multiplex::RequestId">RequestId</a>, body: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>ReadBody)</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#63-66' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Transport%3CReadBody%3E-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../../../implementors/tokio_proto/streaming/multiplex/trait.Transport.js">
|
|||
|
|
</script></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>
|