blob: 90c645006e6a8c3e8cc334771ce69dffccb7307e [file] [log] [blame]
<!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/interval.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>interval.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">&#9776;</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>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
</pre><pre class="rust ">
<span class="doccomment">//! Support for creating futures that represent intervals.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This module contains the `Interval` type which is a stream that will</span>
<span class="doccomment">//! resolve at a fixed intervals in future</span>
<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">Duration</span>, <span class="ident">Instant</span>};
<span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Poll</span>, <span class="ident">Async</span>};
<span class="kw">use</span> <span class="ident">futures</span>::<span class="ident">stream</span>::{<span class="ident">Stream</span>};
<span class="kw">use</span> <span class="ident">reactor</span>::{<span class="ident">Remote</span>, <span class="ident">Handle</span>};
<span class="kw">use</span> <span class="ident">reactor</span>::<span class="ident">timeout_token</span>::<span class="ident">TimeoutToken</span>;
<span class="doccomment">/// A stream representing notifications at fixed interval</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Intervals are created through the `Interval::new` or</span>
<span class="doccomment">/// `Interval::new_at` methods indicating when a first notification</span>
<span class="doccomment">/// should be triggered and when it will be repeated.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that timeouts are not intended for high resolution timers, but rather</span>
<span class="doccomment">/// they will likely fire some granularity after the exact instant that they&#39;re</span>
<span class="doccomment">/// otherwise indicated to fire at.</span>
<span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">&quot;streams do nothing unless polled&quot;</span>]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Interval</span> {
<span class="ident">token</span>: <span class="ident">TimeoutToken</span>,
<span class="ident">next</span>: <span class="ident">Instant</span>,
<span class="ident">interval</span>: <span class="ident">Duration</span>,
<span class="ident">handle</span>: <span class="ident">Remote</span>,
}
<span class="kw">impl</span> <span class="ident">Interval</span> {
<span class="doccomment">/// Creates a new interval which will fire at `dur` time into the future,</span>
<span class="doccomment">/// and will repeat every `dur` interval after</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will return a future that will resolve to the actual</span>
<span class="doccomment">/// interval object. The interval object itself is then a stream which will</span>
<span class="doccomment">/// be set to fire at the specified intervals</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">dur</span>: <span class="ident">Duration</span>, <span class="ident">handle</span>: <span class="kw-2">&amp;</span><span class="ident">Handle</span>) <span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">Interval</span><span class="op">&gt;</span> {
<span class="ident">Interval</span>::<span class="ident">new_at</span>(<span class="ident">Instant</span>::<span class="ident">now</span>() <span class="op">+</span> <span class="ident">dur</span>, <span class="ident">dur</span>, <span class="ident">handle</span>)
}
<span class="doccomment">/// Creates a new interval which will fire at the time specified by `at`,</span>
<span class="doccomment">/// and then will repeat every `dur` interval after</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will return a future that will resolve to the actual</span>
<span class="doccomment">/// timeout object. The timeout object itself is then a future which will be</span>
<span class="doccomment">/// set to fire at the specified point in the future.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new_at</span>(<span class="ident">at</span>: <span class="ident">Instant</span>, <span class="ident">dur</span>: <span class="ident">Duration</span>, <span class="ident">handle</span>: <span class="kw-2">&amp;</span><span class="ident">Handle</span>)
<span class="op">-&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">Interval</span><span class="op">&gt;</span>
{
<span class="prelude-val">Ok</span>(<span class="ident">Interval</span> {
<span class="ident">token</span>: <span class="macro">try</span><span class="macro">!</span>(<span class="ident">TimeoutToken</span>::<span class="ident">new</span>(<span class="ident">at</span>, <span class="kw-2">&amp;</span><span class="ident">handle</span>)),
<span class="ident">next</span>: <span class="ident">at</span>,
<span class="ident">interval</span>: <span class="ident">dur</span>,
<span class="ident">handle</span>: <span class="ident">handle</span>.<span class="ident">remote</span>().<span class="ident">clone</span>(),
})
}
<span class="doccomment">/// Polls this `Interval` instance to see if it&#39;s elapsed, assuming the</span>
<span class="doccomment">/// current time is specified by `now`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `Future::poll` implementation for `Interval` will call `Instant::now`</span>
<span class="doccomment">/// each time it&#39;s invoked, but in some contexts this can be a costly</span>
<span class="doccomment">/// operation. This method is provided to amortize the cost by avoiding</span>
<span class="doccomment">/// usage of `Instant::now`, assuming that it&#39;s been called elsewhere.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function takes the assumed current time as the first parameter and</span>
<span class="doccomment">/// otherwise functions as this future&#39;s `poll` function. This will block a</span>
<span class="doccomment">/// task if one isn&#39;t already blocked or update a previous one if already</span>
<span class="doccomment">/// blocked.</span>
<span class="kw">fn</span> <span class="ident">poll_at</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">now</span>: <span class="ident">Instant</span>) <span class="op">-&gt;</span> <span class="ident">Poll</span><span class="op">&lt;</span><span class="prelude-ty">Option</span><span class="op">&lt;</span>()<span class="op">&gt;</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">next</span> <span class="op">&lt;=</span> <span class="ident">now</span> {
<span class="self">self</span>.<span class="ident">next</span> <span class="op">=</span> <span class="ident">next_interval</span>(<span class="self">self</span>.<span class="ident">next</span>, <span class="ident">now</span>, <span class="self">self</span>.<span class="ident">interval</span>);
<span class="self">self</span>.<span class="ident">token</span>.<span class="ident">reset_timeout</span>(<span class="self">self</span>.<span class="ident">next</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">handle</span>);
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Some</span>(())))
} <span class="kw">else</span> {
<span class="self">self</span>.<span class="ident">token</span>.<span class="ident">update_timeout</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">handle</span>);
<span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>)
}
}
}
<span class="kw">impl</span> <span class="ident">Stream</span> <span class="kw">for</span> <span class="ident">Interval</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> ();
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">io</span>::<span class="ident">Error</span>;
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Poll</span><span class="op">&lt;</span><span class="prelude-ty">Option</span><span class="op">&lt;</span>()<span class="op">&gt;</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
<span class="comment">// TODO: is this fast enough?</span>
<span class="self">self</span>.<span class="ident">poll_at</span>(<span class="ident">Instant</span>::<span class="ident">now</span>())
}
}
<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Interval</span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">token</span>.<span class="ident">cancel_timeout</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">handle</span>);
}
}
<span class="doccomment">/// Converts Duration object to raw nanoseconds if possible</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is useful to divide intervals.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// While technically for large duration it&#39;s impossible to represent any</span>
<span class="doccomment">/// duration as nanoseconds, the largest duration we can represent is about</span>
<span class="doccomment">/// 427_000 years. Large enough for any interval we would use or calculate in</span>
<span class="doccomment">/// tokio.</span>
<span class="kw">fn</span> <span class="ident">duration_to_nanos</span>(<span class="ident">dur</span>: <span class="ident">Duration</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u64</span><span class="op">&gt;</span> {
<span class="ident">dur</span>.<span class="ident">as_secs</span>()
.<span class="ident">checked_mul</span>(<span class="number">1_000_000_000</span>)
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">checked_add</span>(<span class="ident">dur</span>.<span class="ident">subsec_nanos</span>() <span class="kw">as</span> <span class="ident">u64</span>))
}
<span class="kw">fn</span> <span class="ident">next_interval</span>(<span class="ident">prev</span>: <span class="ident">Instant</span>, <span class="ident">now</span>: <span class="ident">Instant</span>, <span class="ident">interval</span>: <span class="ident">Duration</span>) <span class="op">-&gt;</span> <span class="ident">Instant</span> {
<span class="kw">let</span> <span class="ident">new</span> <span class="op">=</span> <span class="ident">prev</span> <span class="op">+</span> <span class="ident">interval</span>;
<span class="kw">if</span> <span class="ident">new</span> <span class="op">&gt;</span> <span class="ident">now</span> {
<span class="kw">return</span> <span class="ident">new</span>;
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="ident">spent_ns</span> <span class="op">=</span> <span class="ident">duration_to_nanos</span>(<span class="ident">now</span>.<span class="ident">duration_since</span>(<span class="ident">prev</span>))
.<span class="ident">expect</span>(<span class="string">&quot;interval should be expired&quot;</span>);
<span class="kw">let</span> <span class="ident">interval_ns</span> <span class="op">=</span> <span class="ident">duration_to_nanos</span>(<span class="ident">interval</span>)
.<span class="ident">expect</span>(<span class="string">&quot;interval is less that 427 thousand years&quot;</span>);
<span class="kw">let</span> <span class="ident">mult</span> <span class="op">=</span> <span class="ident">spent_ns</span><span class="op">/</span><span class="ident">interval_ns</span> <span class="op">+</span> <span class="number">1</span>;
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">mult</span> <span class="op">&lt;</span> (<span class="number">1</span> <span class="op">&lt;&lt;</span> <span class="number">32</span>),
<span class="string">&quot;can&#39;t skip more than 4 billion intervals of {:?} \
(trying to skip {})&quot;</span>, <span class="ident">interval</span>, <span class="ident">mult</span>);
<span class="kw">return</span> <span class="ident">prev</span> <span class="op">+</span> <span class="ident">interval</span> <span class="op">*</span> (<span class="ident">mult</span> <span class="kw">as</span> <span class="ident">u32</span>);
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">test</span> {
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::{<span class="ident">Instant</span>, <span class="ident">Duration</span>};
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">next_interval</span>;
<span class="kw">struct</span> <span class="ident">Timeline</span>(<span class="ident">Instant</span>);
<span class="kw">impl</span> <span class="ident">Timeline</span> {
<span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-&gt;</span> <span class="ident">Timeline</span> {
<span class="ident">Timeline</span>(<span class="ident">Instant</span>::<span class="ident">now</span>())
}
<span class="kw">fn</span> <span class="ident">at</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">millis</span>: <span class="ident">u64</span>) <span class="op">-&gt;</span> <span class="ident">Instant</span> {
<span class="self">self</span>.<span class="number">0</span> <span class="op">+</span> <span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="ident">millis</span>)
}
<span class="kw">fn</span> <span class="ident">at_ns</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">sec</span>: <span class="ident">u64</span>, <span class="ident">nanos</span>: <span class="ident">u32</span>) <span class="op">-&gt;</span> <span class="ident">Instant</span> {
<span class="self">self</span>.<span class="number">0</span> <span class="op">+</span> <span class="ident">Duration</span>::<span class="ident">new</span>(<span class="ident">sec</span>, <span class="ident">nanos</span>)
}
}
<span class="kw">fn</span> <span class="ident">dur</span>(<span class="ident">millis</span>: <span class="ident">u64</span>) <span class="op">-&gt;</span> <span class="ident">Duration</span> {
<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="ident">millis</span>)
}
<span class="comment">// The math around Instant/Duration isn&#39;t 100% precise due to rounding</span>
<span class="comment">// errors, see #249 for more info</span>
<span class="kw">fn</span> <span class="ident">almost_eq</span>(<span class="ident">a</span>: <span class="ident">Instant</span>, <span class="ident">b</span>: <span class="ident">Instant</span>) <span class="op">-&gt;</span> <span class="ident">bool</span> {
<span class="kw">if</span> <span class="ident">a</span> <span class="op">==</span> <span class="ident">b</span> {
<span class="bool-val">true</span>
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">a</span> <span class="op">&gt;</span> <span class="ident">b</span> {
<span class="ident">a</span> <span class="op">-</span> <span class="ident">b</span> <span class="op">&lt;</span> <span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">1</span>)
} <span class="kw">else</span> {
<span class="ident">b</span> <span class="op">-</span> <span class="ident">a</span> <span class="op">&lt;</span> <span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">1</span>)
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">norm_next</span>() {
<span class="kw">let</span> <span class="ident">tm</span> <span class="op">=</span> <span class="ident">Timeline</span>::<span class="ident">new</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">almost_eq</span>(<span class="ident">next_interval</span>(<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">1</span>), <span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">2</span>), <span class="ident">dur</span>(<span class="number">10</span>)),
<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">11</span>)));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">almost_eq</span>(<span class="ident">next_interval</span>(<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">7777</span>), <span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">7788</span>), <span class="ident">dur</span>(<span class="number">100</span>)),
<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">7877</span>)));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">almost_eq</span>(<span class="ident">next_interval</span>(<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">1</span>), <span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">1000</span>), <span class="ident">dur</span>(<span class="number">2100</span>)),
<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">2101</span>)));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">fast_forward</span>() {
<span class="kw">let</span> <span class="ident">tm</span> <span class="op">=</span> <span class="ident">Timeline</span>::<span class="ident">new</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">almost_eq</span>(<span class="ident">next_interval</span>(<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">1</span>), <span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">1000</span>), <span class="ident">dur</span>(<span class="number">10</span>)),
<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">1001</span>)));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">almost_eq</span>(<span class="ident">next_interval</span>(<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">7777</span>), <span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">8888</span>), <span class="ident">dur</span>(<span class="number">100</span>)),
<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">8977</span>)));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">almost_eq</span>(<span class="ident">next_interval</span>(<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">1</span>), <span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">10000</span>), <span class="ident">dur</span>(<span class="number">2100</span>)),
<span class="ident">tm</span>.<span class="ident">at</span>(<span class="number">10501</span>)));
}
<span class="doccomment">/// TODO: this test actually should be successful, but since we can&#39;t</span>
<span class="doccomment">/// multiply Duration on anything larger than u32 easily we decided</span>
<span class="doccomment">/// to allow it to fail for now</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">should_panic</span>(<span class="ident">expected</span> <span class="op">=</span> <span class="string">&quot;can&#39;t skip more than 4 billion intervals&quot;</span>)]</span>
<span class="kw">fn</span> <span class="ident">large_skip</span>() {
<span class="kw">let</span> <span class="ident">tm</span> <span class="op">=</span> <span class="ident">Timeline</span>::<span class="ident">new</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">next_interval</span>(
<span class="ident">tm</span>.<span class="ident">at_ns</span>(<span class="number">0</span>, <span class="number">1</span>), <span class="ident">tm</span>.<span class="ident">at_ns</span>(<span class="number">25</span>, <span class="number">0</span>), <span class="ident">Duration</span>::<span class="ident">new</span>(<span class="number">0</span>, <span class="number">2</span>)),
<span class="ident">tm</span>.<span class="ident">at_ns</span>(<span class="number">25</span>, <span class="number">1</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>&#9166;</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>