doc: 2020-04-01 11:32:45 +0200: 478563f - Adding documentation

This commit is contained in:
2020-04-01 11:47:07 +02:00
commit 527969729d
14503 changed files with 1738402 additions and 0 deletions

955
src/arrayref/lib.rs.html Normal file
View File

@@ -0,0 +1,955 @@
<!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 `/Users/sambuc/.cargo/registry/src/github.com-1ecc6299db9ec823/arrayref-0.3.6/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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><a href='../../arrayref/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></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>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! This package contains just four macros, which enable the creation</span>
<span class="doccomment">//! of array references to portions of arrays or slices (or things</span>
<span class="doccomment">//! that can be sliced).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Examples</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Here is a simple example of slicing and dicing a slice into array</span>
<span class="doccomment">//! references with these macros. Here we implement a simple</span>
<span class="doccomment">//! little-endian conversion from bytes to `u16`, and demonstrate code</span>
<span class="doccomment">//! that uses `array_ref!` to extract an array reference from a larger</span>
<span class="doccomment">//! array. Note that the documentation for each macro also has an</span>
<span class="doccomment">//! example of its use.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! #[macro_use]</span>
<span class="doccomment">//! extern crate arrayref;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! fn read_u16(bytes: &amp;[u8; 2]) -&gt; u16 {</span>
<span class="doccomment">//! bytes[0] as u16 + ((bytes[1] as u16) &lt;&lt; 8)</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! // ...</span>
<span class="doccomment">//! # fn main() {</span>
<span class="doccomment">//! let data = [0,1,2,3,4,0,6,7,8,9];</span>
<span class="doccomment">//! assert_eq!(256, read_u16(array_ref![data,0,2]));</span>
<span class="doccomment">//! assert_eq!(4, read_u16(array_ref![data,4,2]));</span>
<span class="doccomment">//! # }</span>
<span class="doccomment">//! ```</span>
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">warnings</span>)]</span>
<span class="attribute">#![<span class="ident">no_std</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">std</span>;
<span class="doccomment">/// You can use `array_ref` to generate an array reference to a subset</span>
<span class="doccomment">/// of a sliceable bit of data (which could be an array, or a slice,</span>
<span class="doccomment">/// or a Vec).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if the slice is out of bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// #[macro_use]</span>
<span class="doccomment">/// extern crate arrayref;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn read_u16(bytes: &amp;[u8; 2]) -&gt; u16 {</span>
<span class="doccomment">/// bytes[0] as u16 + ((bytes[1] as u16) &lt;&lt; 8)</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// // ...</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// let data = [0,1,2,3,4,0,6,7,8,9];</span>
<span class="doccomment">/// assert_eq!(256, read_u16(array_ref![data,0,2]));</span>
<span class="doccomment">/// assert_eq!(4, read_u16(array_ref![data,4,2]));</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">array_ref</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">offset</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">&gt;</span> {{
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">as_array</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="ident">slice</span>: <span class="kw-2">&amp;</span>[<span class="ident">T</span>]) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span>[<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>] {
<span class="kw-2">&amp;</span><span class="kw-2">*</span>(<span class="ident">slice</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> [<span class="kw">_</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>])
}
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">offset</span>;
<span class="kw">let</span> <span class="ident">slice</span> <span class="op">=</span> <span class="op">&amp;</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>[<span class="ident">offset</span>..<span class="ident">offset</span> <span class="op">+</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>];
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_unsafe</span>)]</span>
<span class="kw">unsafe</span> {
<span class="ident">as_array</span>(<span class="ident">slice</span>)
}
}
}}
}
<span class="doccomment">/// You can use `array_refs` to generate a series of array references</span>
<span class="doccomment">/// to an input array reference. The idea is if you want to break an</span>
<span class="doccomment">/// array into a series of contiguous and non-overlapping arrays.</span>
<span class="doccomment">/// `array_refs` is a bit funny in that it insists on slicing up the</span>
<span class="doccomment">/// *entire* array. This is intentional, as I find it handy to make</span>
<span class="doccomment">/// me ensure that my sub-arrays add up to the entire array. This</span>
<span class="doccomment">/// macro will *never* panic, since the sizes are all checked at</span>
<span class="doccomment">/// compile time.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that unlike `array_ref!`, `array_refs` *requires* that the</span>
<span class="doccomment">/// first argument be an array reference. The following arguments are</span>
<span class="doccomment">/// the lengths of each subarray you wish a reference to. The total</span>
<span class="doccomment">/// of these arguments *must* equal the size of the array itself.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// #[macro_use]</span>
<span class="doccomment">/// extern crate arrayref;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn read_u16(bytes: &amp;[u8; 2]) -&gt; u16 {</span>
<span class="doccomment">/// bytes[0] as u16 + ((bytes[1] as u16) &lt;&lt; 8)</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// // ...</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// let data = [0,1,2,3,4,0,6,7];</span>
<span class="doccomment">/// let (a,b,c) = array_refs![&amp;data,2,2,4];</span>
<span class="doccomment">/// assert_eq!(read_u16(a), 256);</span>
<span class="doccomment">/// assert_eq!(read_u16(b), 3*256+2);</span>
<span class="doccomment">/// assert_eq!(*c, [4,0,6,7]);</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">array_refs</span> {
( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>:<span class="ident">expr</span>, $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span>:<span class="ident">expr</span> ),<span class="op">*</span> ; .. ; $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span>:<span class="ident">expr</span> ),<span class="op">*</span> ) <span class="op">=</span><span class="op">&gt;</span> {{
{
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">slice</span>;
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_assignments</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">eval_order_dependence</span>)]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">as_arrays</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="ident">a</span>: <span class="kw-2">&amp;</span>[<span class="ident">T</span>]) <span class="op">-</span><span class="op">&gt;</span> ( $( <span class="kw-2">&amp;</span>[<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span>], )<span class="op">*</span> <span class="kw-2">&amp;</span>[<span class="ident">T</span>], $( <span class="kw-2">&amp;</span>[<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span>], )<span class="kw-2">*</span>) {
<span class="kw">let</span> <span class="ident">min_len</span> <span class="op">=</span> $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span> <span class="op">+</span> )<span class="op">*</span> $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span> <span class="op">+</span> )<span class="op">*</span> <span class="number">0</span>;
<span class="kw">let</span> <span class="ident">var_len</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">len</span>() <span class="op">-</span> <span class="ident">min_len</span>;
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">a</span>.<span class="ident">len</span>() <span class="op">&gt;</span><span class="op">=</span> <span class="ident">min_len</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">p</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">as_ptr</span>();
( $( {
<span class="kw">let</span> <span class="ident">aref</span> <span class="op">=</span> <span class="op">&amp;</span> <span class="kw-2">*</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span>]);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">aref</span>
} ),<span class="op">*</span> , {
<span class="kw">let</span> <span class="ident">sl</span> <span class="op">=</span> <span class="ident">slice</span>::<span class="ident">from_raw_parts</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">T</span>, <span class="ident">var_len</span>);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="ident">var_len</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">sl</span>
}, $( {
<span class="kw">let</span> <span class="ident">aref</span> <span class="op">=</span> <span class="op">&amp;</span> <span class="kw-2">*</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span>]);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">aref</span>
} ),<span class="kw-2">*</span>)
}
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>;
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_unsafe</span>)]</span>
<span class="kw">unsafe</span> {
<span class="ident">as_arrays</span>(<span class="ident">input</span>)
}
}
}};
( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>:<span class="ident">expr</span>, $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>:<span class="ident">expr</span> ),<span class="op">*</span> ) <span class="op">=</span><span class="op">&gt;</span> {{
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_assignments</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">eval_order_dependence</span>)]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">as_arrays</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="ident">a</span>: <span class="kw-2">&amp;</span>[<span class="ident">T</span>; $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span> <span class="op">+</span> )<span class="op">*</span> <span class="number">0</span> ]) <span class="op">-</span><span class="op">&gt;</span> ( $( <span class="kw-2">&amp;</span>[<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>], )<span class="op">*</span> ) {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">p</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">as_ptr</span>();
( $( {
<span class="kw">let</span> <span class="ident">aref</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="kw-2">*</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>]);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">aref</span>
} ),<span class="op">*</span> )
}
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>;
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_unsafe</span>)]</span>
<span class="kw">unsafe</span> {
<span class="ident">as_arrays</span>(<span class="ident">input</span>)
}
}
}}
}
<span class="doccomment">/// You can use `mut_array_refs` to generate a series of mutable array</span>
<span class="doccomment">/// references to an input mutable array reference. The idea is if</span>
<span class="doccomment">/// you want to break an array into a series of contiguous and</span>
<span class="doccomment">/// non-overlapping mutable array references. Like `array_refs!`,</span>
<span class="doccomment">/// `mut_array_refs!` is a bit funny in that it insists on slicing up</span>
<span class="doccomment">/// the *entire* array. This is intentional, as I find it handy to</span>
<span class="doccomment">/// make me ensure that my sub-arrays add up to the entire array.</span>
<span class="doccomment">/// This macro will *never* panic, since the sizes are all checked at</span>
<span class="doccomment">/// compile time.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that unlike `array_mut_ref!`, `mut_array_refs` *requires*</span>
<span class="doccomment">/// that the first argument be a mutable array reference. The</span>
<span class="doccomment">/// following arguments are the lengths of each subarray you wish a</span>
<span class="doccomment">/// reference to. The total of these arguments *must* equal the size</span>
<span class="doccomment">/// of the array itself. Also note that this macro allows you to take</span>
<span class="doccomment">/// out multiple mutable references to a single object, which is both</span>
<span class="doccomment">/// weird and powerful.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// #[macro_use]</span>
<span class="doccomment">/// extern crate arrayref;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn write_u16(bytes: &amp;mut [u8; 2], num: u16) {</span>
<span class="doccomment">/// bytes[0] = num as u8;</span>
<span class="doccomment">/// bytes[1] = (num &gt;&gt; 8) as u8;</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// fn write_u32(bytes: &amp;mut [u8; 4], num: u32) {</span>
<span class="doccomment">/// bytes[0] = num as u8;</span>
<span class="doccomment">/// bytes[1] = (num &gt;&gt; 8) as u8; // this is buggy to save space...</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// // ...</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// let mut data = [0,1,2,3,4,0,6,7];</span>
<span class="doccomment">/// let (a,b,c) = mut_array_refs![&amp;mut data,2,2,4];</span>
<span class="doccomment">/// // let&#39;s write out some nice prime numbers!</span>
<span class="doccomment">/// write_u16(a, 37);</span>
<span class="doccomment">/// write_u16(b, 73);</span>
<span class="doccomment">/// write_u32(c, 137); // approximate inverse of the fine structure constant!</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">mut_array_refs</span> {
( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>:<span class="ident">expr</span>, $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span>:<span class="ident">expr</span> ),<span class="op">*</span> ; .. ; $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span>:<span class="ident">expr</span> ),<span class="op">*</span> ) <span class="op">=</span><span class="op">&gt;</span> {{
{
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">slice</span>;
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_assignments</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">eval_order_dependence</span>)]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">as_arrays</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="ident">a</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>]) <span class="op">-</span><span class="op">&gt;</span> ( $( <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span>], )<span class="op">*</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>], $( <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span>], )<span class="kw-2">*</span>) {
<span class="kw">let</span> <span class="ident">min_len</span> <span class="op">=</span> $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span> <span class="op">+</span> )<span class="op">*</span> $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span> <span class="op">+</span> )<span class="op">*</span> <span class="number">0</span>;
<span class="kw">let</span> <span class="ident">var_len</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">len</span>() <span class="op">-</span> <span class="ident">min_len</span>;
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">a</span>.<span class="ident">len</span>() <span class="op">&gt;</span><span class="op">=</span> <span class="ident">min_len</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">p</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">as_mut_ptr</span>();
( $( {
<span class="kw">let</span> <span class="ident">aref</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="kw-2">*</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span>]);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">pre</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">aref</span>
} ),<span class="op">*</span> , {
<span class="kw">let</span> <span class="ident">sl</span> <span class="op">=</span> <span class="ident">slice</span>::<span class="ident">from_raw_parts_mut</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>, <span class="ident">var_len</span>);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="ident">var_len</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">sl</span>
}, $( {
<span class="kw">let</span> <span class="ident">aref</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="kw-2">*</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span>]);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">post</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">aref</span>
} ),<span class="kw-2">*</span>)
}
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>;
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_unsafe</span>)]</span>
<span class="kw">unsafe</span> {
<span class="ident">as_arrays</span>(<span class="ident">input</span>)
}
}
}};
( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>:<span class="ident">expr</span>, $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>:<span class="ident">expr</span> ),<span class="op">*</span> ) <span class="op">=</span><span class="op">&gt;</span> {{
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_assignments</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">eval_order_dependence</span>)]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">as_arrays</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="ident">a</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>; $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span> <span class="op">+</span> )<span class="op">*</span> <span class="number">0</span> ]) <span class="op">-</span><span class="op">&gt;</span> ( $( <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>], )<span class="op">*</span> ) {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">p</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">as_mut_ptr</span>();
( $( {
<span class="kw">let</span> <span class="ident">aref</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="kw-2">*</span>(<span class="ident">p</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>]);
<span class="ident">p</span> <span class="op">=</span> <span class="ident">p</span>.<span class="ident">offset</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span> <span class="kw">as</span> <span class="ident">isize</span>);
<span class="ident">aref</span>
} ),<span class="op">*</span> )
}
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>;
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_unsafe</span>)]</span>
<span class="kw">unsafe</span> {
<span class="ident">as_arrays</span>(<span class="ident">input</span>)
}
}
}};
}
<span class="doccomment">/// You can use `array_mut_ref` to generate a mutable array reference</span>
<span class="doccomment">/// to a subset of a sliceable bit of data (which could be an array,</span>
<span class="doccomment">/// or a slice, or a Vec).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if the slice is out of bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// #[macro_use]</span>
<span class="doccomment">/// extern crate arrayref;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn write_u16(bytes: &amp;mut [u8; 2], num: u16) {</span>
<span class="doccomment">/// bytes[0] = num as u8;</span>
<span class="doccomment">/// bytes[1] = (num &gt;&gt; 8) as u8;</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// // ...</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// let mut data = [0,1,2,3,4,0,6,7,8,9];</span>
<span class="doccomment">/// write_u16(array_mut_ref![data,0,2], 1);</span>
<span class="doccomment">/// write_u16(array_mut_ref![data,2,2], 5);</span>
<span class="doccomment">/// assert_eq!(*array_ref![data,0,4], [1,0,5,0]);</span>
<span class="doccomment">/// *array_mut_ref![data,4,5] = [4,3,2,1,0];</span>
<span class="doccomment">/// assert_eq!(data, [1,0,5,0,4,3,2,1,0,9]);</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">array_mut_ref</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">offset</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">&gt;</span> {{
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">as_array</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span>(<span class="ident">slice</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>]) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">T</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>] {
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="kw-2">*</span>(<span class="ident">slice</span>.<span class="ident">as_mut_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> [<span class="kw">_</span>; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>])
}
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">offset</span>;
<span class="kw">let</span> <span class="ident">slice</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arr</span>[<span class="ident">offset</span>..<span class="ident">offset</span> <span class="op">+</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">len</span>];
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">unused_unsafe</span>)]</span>
<span class="kw">unsafe</span> {
<span class="ident">as_array</span>(<span class="ident">slice</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">extern</span> <span class="kw">crate</span> <span class="ident">quickcheck</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">vec</span>::<span class="ident">Vec</span>;
<span class="comment">// use super::*;</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">should_panic</span>]</span>
<span class="kw">fn</span> <span class="ident">checks_bounds</span>() {
<span class="kw">let</span> <span class="ident">foo</span>: [<span class="ident">u8</span>; <span class="number">11</span>] <span class="op">=</span> [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">10</span>];
<span class="kw">let</span> <span class="ident">bar</span> <span class="op">=</span> <span class="macro">array_ref</span><span class="macro">!</span>(<span class="ident">foo</span>, <span class="number">1</span>, <span class="number">11</span>);
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;I am checking that I can dereference bar[0] = {}&quot;</span>, <span class="ident">bar</span>[<span class="number">0</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">simple_case_works</span>() {
<span class="kw">fn</span> <span class="ident">check</span>(<span class="ident">expected</span>: [<span class="ident">u8</span>; <span class="number">3</span>], <span class="ident">actual</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>; <span class="number">3</span>]) {
<span class="kw">for</span> (<span class="ident">e</span>, <span class="ident">a</span>) <span class="kw">in</span> (<span class="kw-2">&amp;</span><span class="ident">expected</span>).<span class="ident">iter</span>().<span class="ident">zip</span>(<span class="ident">actual</span>.<span class="ident">iter</span>()) {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>, <span class="ident">a</span>)
}
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">foo</span>: [<span class="ident">u8</span>; <span class="number">11</span>] <span class="op">=</span> [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">10</span>];
{
<span class="kw">let</span> <span class="ident">bar</span> <span class="op">=</span> <span class="macro">array_ref</span><span class="macro">!</span>(<span class="ident">foo</span>, <span class="number">2</span>, <span class="number">3</span>);
<span class="ident">check</span>([<span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>], <span class="ident">bar</span>);
}
<span class="ident">check</span>([<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>], <span class="macro">array_ref</span><span class="macro">!</span>(<span class="ident">foo</span>, <span class="number">0</span>, <span class="number">3</span>));
<span class="kw">fn</span> <span class="ident">zero2</span>(<span class="ident">x</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">u8</span>; <span class="number">2</span>]) {
<span class="ident">x</span>[<span class="number">0</span>] <span class="op">=</span> <span class="number">0</span>;
<span class="ident">x</span>[<span class="number">1</span>] <span class="op">=</span> <span class="number">0</span>;
}
<span class="ident">zero2</span>(<span class="macro">array_mut_ref</span><span class="macro">!</span>(<span class="ident">foo</span>, <span class="number">8</span>, <span class="number">2</span>));
<span class="ident">check</span>([<span class="number">0</span>, <span class="number">0</span>, <span class="number">10</span>], <span class="macro">array_ref</span><span class="macro">!</span>(<span class="ident">foo</span>, <span class="number">8</span>, <span class="number">3</span>));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">check_array_ref_5</span>() {
<span class="kw">fn</span> <span class="ident">f</span>(<span class="ident">data</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">offset</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span> {
<span class="kw">if</span> <span class="ident">data</span>.<span class="ident">len</span>() <span class="op">&lt;</span> <span class="ident">offset</span> <span class="op">+</span> <span class="number">5</span> {
<span class="kw">return</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">discard</span>();
}
<span class="kw">let</span> <span class="ident">out</span> <span class="op">=</span> <span class="macro">array_ref</span><span class="macro">!</span>(<span class="ident">data</span>, <span class="ident">offset</span>, <span class="number">5</span>);
<span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">from_bool</span>(<span class="ident">out</span>.<span class="ident">len</span>() <span class="op">=</span><span class="op">=</span> <span class="number">5</span>)
}
<span class="ident">quickcheck</span>::<span class="ident">quickcheck</span>(<span class="ident">f</span> <span class="kw">as</span> <span class="kw">fn</span>(<span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">check_array_ref_out_of_bounds_5</span>() {
<span class="kw">fn</span> <span class="ident">f</span>(<span class="ident">data</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">offset</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span> {
<span class="kw">if</span> <span class="ident">data</span>.<span class="ident">len</span>() <span class="op">&gt;</span><span class="op">=</span> <span class="ident">offset</span> <span class="op">+</span> <span class="number">5</span> {
<span class="kw">return</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">discard</span>();
}
<span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">must_fail</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
<span class="macro">array_ref</span><span class="macro">!</span>(<span class="ident">data</span>, <span class="ident">offset</span>, <span class="number">5</span>);
})
}
<span class="ident">quickcheck</span>::<span class="ident">quickcheck</span>(<span class="ident">f</span> <span class="kw">as</span> <span class="kw">fn</span>(<span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">check_array_mut_ref_7</span>() {
<span class="kw">fn</span> <span class="ident">f</span>(<span class="kw-2">mut</span> <span class="ident">data</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">offset</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span> {
<span class="kw">if</span> <span class="ident">data</span>.<span class="ident">len</span>() <span class="op">&lt;</span> <span class="ident">offset</span> <span class="op">+</span> <span class="number">7</span> {
<span class="kw">return</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">discard</span>();
}
<span class="kw">let</span> <span class="ident">out</span> <span class="op">=</span> <span class="macro">array_mut_ref</span><span class="macro">!</span>(<span class="ident">data</span>, <span class="ident">offset</span>, <span class="number">7</span>);
<span class="ident">out</span>[<span class="number">6</span>] <span class="op">=</span> <span class="number">3</span>;
<span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">from_bool</span>(<span class="ident">out</span>.<span class="ident">len</span>() <span class="op">=</span><span class="op">=</span> <span class="number">7</span>)
}
<span class="ident">quickcheck</span>::<span class="ident">quickcheck</span>(<span class="ident">f</span> <span class="kw">as</span> <span class="kw">fn</span>(<span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">check_array_mut_ref_out_of_bounds_32</span>() {
<span class="kw">fn</span> <span class="ident">f</span>(<span class="kw-2">mut</span> <span class="ident">data</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">offset</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span> {
<span class="kw">if</span> <span class="ident">data</span>.<span class="ident">len</span>() <span class="op">&gt;</span><span class="op">=</span> <span class="ident">offset</span> <span class="op">+</span> <span class="number">32</span> {
<span class="kw">return</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">discard</span>();
}
<span class="ident">quickcheck</span>::<span class="ident">TestResult</span>::<span class="ident">must_fail</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
<span class="macro">array_mut_ref</span><span class="macro">!</span>(<span class="ident">data</span>, <span class="ident">offset</span>, <span class="number">32</span>);
})
}
<span class="ident">quickcheck</span>::<span class="ident">quickcheck</span>(<span class="ident">f</span> <span class="kw">as</span> <span class="kw">fn</span>(<span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span>, <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">quickcheck</span>::<span class="ident">TestResult</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_5_array_refs</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">data</span>: [<span class="ident">usize</span>; <span class="number">128</span>] <span class="op">=</span> [<span class="number">0</span>; <span class="number">128</span>];
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">128</span> {
<span class="ident">data</span>[<span class="ident">i</span>] <span class="op">=</span> <span class="ident">i</span>;
}
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident">data</span>;
<span class="kw">let</span> (<span class="ident">a</span>,<span class="ident">b</span>,<span class="ident">c</span>,<span class="ident">d</span>,<span class="ident">e</span>) <span class="op">=</span> <span class="macro">array_refs</span><span class="macro">!</span>(<span class="kw-2">&amp;</span><span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>, <span class="number">3</span>, <span class="number">100</span>, <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>.<span class="ident">len</span>(), <span class="number">1</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>.<span class="ident">len</span>(), <span class="number">14</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">len</span>(), <span class="number">3</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">len</span>(), <span class="number">100</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">len</span>(), <span class="number">10</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">0</span>, <span class="number">1</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">15</span>, <span class="number">3</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">118</span>, <span class="number">10</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_5_array_refs_dotdot</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">data</span>: [<span class="ident">usize</span>; <span class="number">128</span>] <span class="op">=</span> [<span class="number">0</span>; <span class="number">128</span>];
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">128</span> {
<span class="ident">data</span>[<span class="ident">i</span>] <span class="op">=</span> <span class="ident">i</span>;
}
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident">data</span>;
<span class="kw">let</span> (<span class="ident">a</span>,<span class="ident">b</span>,<span class="ident">c</span>,<span class="ident">d</span>,<span class="ident">e</span>) <span class="op">=</span> <span class="macro">array_refs</span><span class="macro">!</span>(<span class="kw-2">&amp;</span><span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>, <span class="number">3</span>; ..; <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>.<span class="ident">len</span>(), <span class="number">1</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>.<span class="ident">len</span>(), <span class="number">14</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">len</span>(), <span class="number">3</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">len</span>(), <span class="number">100</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">len</span>(), <span class="number">10</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">0</span>, <span class="number">1</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">15</span>, <span class="number">3</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>, <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">118</span>, <span class="number">10</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_5_mut_xarray_refs</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">data</span>: [<span class="ident">usize</span>; <span class="number">128</span>] <span class="op">=</span> [<span class="number">0</span>; <span class="number">128</span>];
{
<span class="comment">// temporarily borrow the data to modify it.</span>
<span class="kw">let</span> (<span class="ident">a</span>,<span class="ident">b</span>,<span class="ident">c</span>,<span class="ident">d</span>,<span class="ident">e</span>) <span class="op">=</span> <span class="macro">mut_array_refs</span><span class="macro">!</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>, <span class="number">3</span>, <span class="number">100</span>, <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>.<span class="ident">len</span>(), <span class="number">1</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>.<span class="ident">len</span>(), <span class="number">14</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">len</span>(), <span class="number">3</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">len</span>(), <span class="number">100</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">len</span>(), <span class="number">10</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="kw-2">*</span><span class="ident">a</span> <span class="op">=</span> [<span class="number">1</span>; <span class="number">1</span>];
<span class="kw-2">*</span><span class="ident">b</span> <span class="op">=</span> [<span class="number">14</span>; <span class="number">14</span>];
<span class="kw-2">*</span><span class="ident">c</span> <span class="op">=</span> [<span class="number">3</span>; <span class="number">3</span>];
<span class="kw-2">*</span><span class="ident">d</span> <span class="op">=</span> [<span class="number">100</span>; <span class="number">100</span>];
<span class="kw-2">*</span><span class="ident">e</span> <span class="op">=</span> [<span class="number">10</span>; <span class="number">10</span>];
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">1</span>;<span class="number">1</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">0</span>, <span class="number">1</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">14</span>;<span class="number">14</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">3</span>;<span class="number">3</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">15</span>, <span class="number">3</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">10</span>;<span class="number">10</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">118</span>, <span class="number">10</span>]);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_5_mut_xarray_refs_with_dotdot</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">data</span>: [<span class="ident">usize</span>; <span class="number">128</span>] <span class="op">=</span> [<span class="number">0</span>; <span class="number">128</span>];
{
<span class="comment">// temporarily borrow the data to modify it.</span>
<span class="kw">let</span> (<span class="ident">a</span>,<span class="ident">b</span>,<span class="ident">c</span>,<span class="ident">d</span>,<span class="ident">e</span>) <span class="op">=</span> <span class="macro">mut_array_refs</span><span class="macro">!</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>, <span class="number">3</span>; ..; <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">a</span>.<span class="ident">len</span>(), <span class="number">1</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>.<span class="ident">len</span>(), <span class="number">14</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">c</span>.<span class="ident">len</span>(), <span class="number">3</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">len</span>(), <span class="number">100</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">e</span>.<span class="ident">len</span>(), <span class="number">10</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="kw-2">*</span><span class="ident">a</span> <span class="op">=</span> [<span class="number">1</span>; <span class="number">1</span>];
<span class="kw-2">*</span><span class="ident">b</span> <span class="op">=</span> [<span class="number">14</span>; <span class="number">14</span>];
<span class="kw-2">*</span><span class="ident">c</span> <span class="op">=</span> [<span class="number">3</span>; <span class="number">3</span>];
<span class="kw-2">*</span><span class="ident">e</span> <span class="op">=</span> [<span class="number">10</span>; <span class="number">10</span>];
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">1</span>;<span class="number">1</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">0</span>, <span class="number">1</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">14</span>;<span class="number">14</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">1</span>, <span class="number">14</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">3</span>;<span class="number">3</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">15</span>, <span class="number">3</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&amp;</span>[<span class="number">10</span>;<span class="number">10</span>], <span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>, <span class="number">118</span>, <span class="number">10</span>]);
}
} <span class="comment">// mod test</span>
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "arrayref";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>