172 lines
23 KiB
HTML
172 lines
23 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 `Dispatch` trait in crate `tokio_proto`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Dispatch">
|
|||
|
|
|
|||
|
|
<title>tokio_proto::streaming::multiplex::advanced::Dispatch - 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 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 Dispatch</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Io">Io</a><a href="#associatedtype.In">In</a><a href="#associatedtype.BodyIn">BodyIn</a><a href="#associatedtype.Out">Out</a><a href="#associatedtype.BodyOut">BodyOut</a><a href="#associatedtype.Error">Error</a><a href="#associatedtype.Stream">Stream</a><a href="#associatedtype.Transport">Transport</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.transport">transport</a><a href="#tymethod.poll">poll</a><a href="#tymethod.poll_ready">poll_ready</a><a href="#tymethod.dispatch">dispatch</a><a href="#tymethod.cancel">cancel</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>::<wbr><a href='index.html'>advanced</a></p><script>window.sidebarCurrent = {name: 'Dispatch', 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 href='index.html'>advanced</a>::<wbr><a class="trait" href=''>Dispatch</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#166-207' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait Dispatch {
|
|||
|
|
type <a href='#associatedtype.Io' class="type">Io</a>;
|
|||
|
|
type <a href='#associatedtype.In' class="type">In</a>;
|
|||
|
|
type <a href='#associatedtype.BodyIn' class="type">BodyIn</a>;
|
|||
|
|
type <a href='#associatedtype.Out' class="type">Out</a>;
|
|||
|
|
type <a href='#associatedtype.BodyOut' class="type">BodyOut</a>;
|
|||
|
|
type <a href='#associatedtype.Error' class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</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>>;
|
|||
|
|
type <a href='#associatedtype.Stream' class="type">Stream</a>: <a class="trait" href="../../../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyIn" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyIn">BodyIn</a>, Error = Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>>;
|
|||
|
|
type <a href='#associatedtype.Transport' class="type">Transport</a>: <a class="trait" href="../../../../tokio_proto/streaming/multiplex/trait.Transport.html" title="trait tokio_proto::streaming::multiplex::Transport">Transport</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyOut" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyOut">BodyOut</a>, Item = <a class="enum" href="../../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Out" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Out">Out</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyOut" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyOut">BodyOut</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>>, SinkItem = <a class="enum" href="../../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.In" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::In">In</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyIn" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyIn">BodyIn</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>>>;
|
|||
|
|
fn <a href='#tymethod.transport' class='fnname'>transport</a>(&mut self) -> &mut Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Transport" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Transport">Transport</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.poll' class='fnname'>poll</a>(<br> &mut self<br> ) -> <a class="type" href="../../../../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../../../tokio_proto/streaming/multiplex/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.In" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::In">In</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Stream" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Stream">Stream</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</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>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.poll_ready' class='fnname'>poll_ready</a>(&self) -> <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='#tymethod.dispatch' class='fnname'>dispatch</a>(<br> &mut self, <br> message: <a class="struct" href="../../../../tokio_proto/streaming/multiplex/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Out" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Out">Out</a>, <a class="struct" href="../../../../tokio_proto/streaming/struct.Body.html" title="struct tokio_proto::streaming::Body">Body</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyOut" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyOut">BodyOut</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>><br> ) -> <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='#tymethod.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>>;
|
|||
|
|
}</pre><div class='docblock'><p>Dispatch messages from the transport to the service</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='associatedtype.Io' class='method'><span id='Io.t' class='invisible'><code>type <a href='#associatedtype.Io' class="type">Io</a></code></span></h3><div class='docblock'><p>Type of underlying I/O object</p>
|
|||
|
|
</div><h3 id='associatedtype.In' class='method'><span id='In.t' class='invisible'><code>type <a href='#associatedtype.In' class="type">In</a></code></span></h3><div class='docblock'><p>Messages written to the transport</p>
|
|||
|
|
</div><h3 id='associatedtype.BodyIn' class='method'><span id='BodyIn.t' class='invisible'><code>type <a href='#associatedtype.BodyIn' class="type">BodyIn</a></code></span></h3><div class='docblock'><p>Inbound body frame</p>
|
|||
|
|
</div><h3 id='associatedtype.Out' class='method'><span id='Out.t' class='invisible'><code>type <a href='#associatedtype.Out' class="type">Out</a></code></span></h3><div class='docblock'><p>Messages read from the transport</p>
|
|||
|
|
</div><h3 id='associatedtype.BodyOut' class='method'><span id='BodyOut.t' class='invisible'><code>type <a href='#associatedtype.BodyOut' class="type">BodyOut</a></code></span></h3><div class='docblock'><p>Outbound body frame</p>
|
|||
|
|
</div><h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</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></h3><div class='docblock'><p>Transport error</p>
|
|||
|
|
</div><h3 id='associatedtype.Stream' class='method'><span id='Stream.t' class='invisible'><code>type <a href='#associatedtype.Stream' class="type">Stream</a>: <a class="trait" href="../../../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyIn" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyIn">BodyIn</a>, Error = Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>></code></span></h3><div class='docblock'><p>Inbound body stream type</p>
|
|||
|
|
</div><h3 id='associatedtype.Transport' class='method'><span id='Transport.t' class='invisible'><code>type <a href='#associatedtype.Transport' class="type">Transport</a>: <a class="trait" href="../../../../tokio_proto/streaming/multiplex/trait.Transport.html" title="trait tokio_proto::streaming::multiplex::Transport">Transport</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyOut" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyOut">BodyOut</a>, Item = <a class="enum" href="../../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Out" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Out">Out</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyOut" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyOut">BodyOut</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>>, SinkItem = <a class="enum" href="../../../../tokio_proto/streaming/multiplex/enum.Frame.html" title="enum tokio_proto::streaming::multiplex::Frame">Frame</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.In" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::In">In</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyIn" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyIn">BodyIn</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>>></code></span></h3><div class='docblock'><p>Transport type</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.transport' class='method'><span id='transport.v' class='invisible'><code>fn <a href='#tymethod.transport' class='fnname'>transport</a>(&mut self) -> &mut Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Transport" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Transport">Transport</a></code></span></h3><div class='docblock'><p>Mutable reference to the transport</p>
|
|||
|
|
</div><h3 id='tymethod.poll' class='method'><span id='poll.v' class='invisible'><code>fn <a href='#tymethod.poll' class='fnname'>poll</a>(<br> &mut self<br>) -> <a class="type" href="../../../../futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../../../tokio_proto/streaming/multiplex/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.In" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::In">In</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Stream" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Stream">Stream</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</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></h3><div class='docblock'><p>Poll the next available message</p>
|
|||
|
|
</div><h3 id='tymethod.poll_ready' class='method'><span id='poll_ready.v' class='invisible'><code>fn <a href='#tymethod.poll_ready' class='fnname'>poll_ready</a>(&self) -> <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>The <code>Dispatch</code> is ready to accept another message</p>
|
|||
|
|
</div><h3 id='tymethod.dispatch' class='method'><span id='dispatch.v' class='invisible'><code>fn <a href='#tymethod.dispatch' class='fnname'>dispatch</a>(<br> &mut self, <br> message: <a class="struct" href="../../../../tokio_proto/streaming/multiplex/advanced/struct.MultiplexMessage.html" title="struct tokio_proto::streaming::multiplex::advanced::MultiplexMessage">MultiplexMessage</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Out" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Out">Out</a>, <a class="struct" href="../../../../tokio_proto/streaming/struct.Body.html" title="struct tokio_proto::streaming::Body">Body</a><Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.BodyOut" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::BodyOut">BodyOut</a>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>>, Self::<a class="type" href="../../../../tokio_proto/streaming/multiplex/advanced/trait.Dispatch.html#associatedtype.Error" title="type tokio_proto::streaming::multiplex::advanced::Dispatch::Error">Error</a>><br>) -> <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>Process an out message</p>
|
|||
|
|
</div><h3 id='tymethod.cancel' class='method'><span id='cancel.v' class='invisible'><code>fn <a href='#tymethod.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></div>
|
|||
|
|
<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" async
|
|||
|
|
src="../../../../implementors/tokio_proto/streaming/multiplex/advanced/trait.Dispatch.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>
|