| <!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="Source to the Rust file `src/reactor/timeout_token.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>timeout_token.rs.html -- source</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 source"> |
| <!--[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> |
| |
| |
| </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"><pre class="line-numbers"><span id="1"> 1</span> |
| <span id="2"> 2</span> |
| <span id="3"> 3</span> |
| <span id="4"> 4</span> |
| <span id="5"> 5</span> |
| <span id="6"> 6</span> |
| <span id="7"> 7</span> |
| <span id="8"> 8</span> |
| <span id="9"> 9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| </pre><pre class="rust "> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Instant</span>; |
| |
| <span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">task</span>; |
| |
| <span class="kw">use</span> <span class="ident">reactor</span>::{<span class="ident">Message</span>, <span class="ident">Handle</span>, <span class="ident">Remote</span>}; |
| |
| <span class="doccomment">/// A token that identifies an active timeout.</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">TimeoutToken</span> { |
| <span class="ident">token</span>: <span class="ident">usize</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">TimeoutToken</span> { |
| <span class="doccomment">/// Adds a new timeout to get fired at the specified instant, notifying the</span> |
| <span class="doccomment">/// specified task.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">at</span>: <span class="ident">Instant</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Handle</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">TimeoutToken</span><span class="op">></span> { |
| <span class="kw">match</span> <span class="ident">handle</span>.<span class="ident">inner</span>.<span class="ident">upgrade</span>() { |
| <span class="prelude-val">Some</span>(<span class="ident">inner</span>) <span class="op">=></span> { |
| <span class="kw">let</span> <span class="ident">token</span> <span class="op">=</span> <span class="ident">inner</span>.<span class="ident">borrow_mut</span>().<span class="ident">add_timeout</span>(<span class="ident">at</span>); |
| <span class="prelude-val">Ok</span>(<span class="ident">TimeoutToken</span> { <span class="ident">token</span>: <span class="ident">token</span> }) |
| } |
| <span class="prelude-val">None</span> <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">Other</span>, <span class="string">"event loop gone"</span>)), |
| } |
| } |
| |
| <span class="doccomment">/// Updates a previously added timeout to notify a new task instead.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will panic if the timeout specified was not created by this</span> |
| <span class="doccomment">/// loop handle's `add_timeout` method.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">update_timeout</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Remote</span>) { |
| <span class="ident">handle</span>.<span class="ident">send</span>(<span class="ident">Message</span>::<span class="ident">UpdateTimeout</span>(<span class="self">self</span>.<span class="ident">token</span>, <span class="ident">task</span>::<span class="ident">current</span>())) |
| } |
| |
| <span class="doccomment">/// Resets previously added (or fired) timeout to an new timeout</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will panic if the timeout specified was not created by this</span> |
| <span class="doccomment">/// loop handle's `add_timeout` method.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">reset_timeout</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">at</span>: <span class="ident">Instant</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Remote</span>) { |
| <span class="ident">handle</span>.<span class="ident">send</span>(<span class="ident">Message</span>::<span class="ident">ResetTimeout</span>(<span class="self">self</span>.<span class="ident">token</span>, <span class="ident">at</span>)); |
| } |
| |
| <span class="doccomment">/// Cancel a previously added timeout.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will panic if the timeout specified was not created by this</span> |
| <span class="doccomment">/// loop handle's `add_timeout` method or if called multiple times.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">cancel_timeout</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">handle</span>: <span class="kw-2">&</span><span class="ident">Remote</span>) { |
| <span class="macro">debug</span><span class="macro">!</span>(<span class="string">"cancel timeout {}"</span>, <span class="self">self</span>.<span class="ident">token</span>); |
| <span class="ident">handle</span>.<span class="ident">send</span>(<span class="ident">Message</span>::<span class="ident">CancelTimeout</span>(<span class="self">self</span>.<span class="ident">token</span>)) |
| } |
| } |
| </pre> |
| </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_core"; |
| </script> |
| <script src="../../../main.js"></script> |
| <script defer src="../../../search-index.js"></script> |
| </body> |
| </html> |
