| <!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 `Token` struct in crate `paho_mqtt`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, Token"> |
| |
| <title>paho_mqtt::async_client::Token - Rust</title> |
| |
| <link rel="stylesheet" type="text/css" href="../../normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> |
| <link rel="stylesheet" type="text/css" href="../../main.css"> |
| |
| |
| |
| |
| </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"> |
| |
| <p class='location'>Struct Token</p><div class="block items"><ul><li><a href="#methods">Methods</a></li></ul></div><p class='location'><a href='../index.html'>paho_mqtt</a>::<wbr><a href='index.html'>async_client</a></p><script>window.sidebarCurrent = {name: 'Token', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script> |
| </nav> |
| |
| <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'>paho_mqtt</a>::<wbr><a href='index.html'>async_client</a>::<wbr><a class="struct" href=''>Token</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/paho_mqtt/async_client.rs.html#66-80' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust struct'>pub struct Token { /* fields omitted */ }</pre><div class='docblock'><p>A <code>Token</code> is a mechanism for tracking the progress of an asynchronous |
| operation.</p> |
| </div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../paho_mqtt/async_client/struct.Token.html" title="struct paho_mqtt::async_client::Token">Token</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/paho_mqtt/async_client.rs.html#82-301' 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>fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../../paho_mqtt/async_client/struct.Token.html" title="struct paho_mqtt::async_client::Token">Token</a></code></span></h4> |
| <div class='docblock'><p>Creates a new, unsignaled Token.</p> |
| </div><h4 id='method.from_message' class="method"><span id='from_message.v' class='invisible'><code>fn <a href='#method.from_message' class='fnname'>from_message</a>(msg: <a class="struct" href="../../paho_mqtt/message/struct.Message.html" title="struct paho_mqtt::message::Message">Message</a>) -> <a class="struct" href="../../paho_mqtt/async_client/struct.Token.html" title="struct paho_mqtt::async_client::Token">Token</a></code></span></h4> |
| <div class='docblock'><p>Creates a new, unsignalled delivery Token. |
| This ia a token which tracks delivery of a message.</p> |
| </div><h4 id='method.from_client' class="method"><span id='from_client.v' class='invisible'><code>fn <a href='#method.from_client' class='fnname'>from_client</a><FS, FF>(<br> cli: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="struct" href="../../paho_mqtt/async_client/struct.AsyncClient.html" title="struct paho_mqtt::async_client::AsyncClient">AsyncClient</a>, <br> success_cb: FS, <br> failure_cb: FF<br>) -> <a class="struct" href="../../paho_mqtt/async_client/struct.Token.html" title="struct paho_mqtt::async_client::Token">Token</a> <span class="where fmt-newline">where<br> FS: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../../paho_mqtt/async_client/struct.AsyncClient.html" title="struct paho_mqtt::async_client::AsyncClient">AsyncClient</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) + 'static,<br> FF: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../../paho_mqtt/async_client/struct.AsyncClient.html" title="struct paho_mqtt::async_client::AsyncClient">AsyncClient</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) + 'static, </span></code></span></h4> |
| <div class='docblock'><p>Creates a new, unsignalled Token with callbacks.</p> |
| </div><h4 id='method.from_error' class="method"><span id='from_error.v' class='invisible'><code>fn <a href='#method.from_error' class='fnname'>from_error</a>(rc: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="struct" href="../../paho_mqtt/async_client/struct.Token.html" title="struct paho_mqtt::async_client::Token">Token</a></code></span></h4> |
| <div class='docblock'><p>Creates a new Token signalled with an error.</p> |
| </div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><code>fn <a href='#method.wait' class='fnname'>wait</a>(&self) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4> |
| <div class='docblock'><p>Blocks the caller until the asynchronous operation has completed.</p> |
| </div><h4 id='method.wait_for' class="method"><span id='wait_for.v' class='invisible'><code>fn <a href='#method.wait_for' class='fnname'>wait_for</a>(&self, dur: <a class="struct" href="https://doc.rust-lang.org/nightly/std/time/duration/struct.Duration.html" title="struct std::time::duration::Duration">Duration</a>) -> <a class="type" href="../../paho_mqtt/errors/type.MqttResult.html" title="type paho_mqtt::errors::MqttResult">MqttResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4> |
| <div class='docblock'><p>Blocks the caller a limited amount of time waiting for the |
| asynchronous operation to complete.</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>?</dt> |
| <dd>Show this help dialog</dd> |
| <dt>S</dt> |
| <dd>Focus the search field</dd> |
| <dt>⇤</dt> |
| <dd>Move up in search results</dd> |
| <dt>⇥</dt> |
| <dd>Move down in search results</dd> |
| <dt>⏎</dt> |
| <dd>Go to active search result</dd> |
| <dt>+</dt> |
| <dd>Collapse/expand 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 = "paho_mqtt"; |
| </script> |
| <script src="../../main.js"></script> |
| <script defer src="../../search-index.js"></script> |
| </body> |
| </html> |
