diff options
| author | 2015-06-29 20:16:15 +0000 | |
|---|---|---|
| committer | 2015-06-29 20:16:15 +0000 | |
| commit | 64106c4d3d4ddba8c7bc2af75376e6d3d3d75601 (patch) | |
| tree | 8c64d6e8be006486d975a651505fbbde61365cd6 /src/bitflags/lib.rs.html | |
| download | irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.tar.gz irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.tar.xz irsc-64106c4d3d4ddba8c7bc2af75376e6d3d3d75601.zip | |
Update documentationgh-pages
Diffstat (limited to 'src/bitflags/lib.rs.html')
| -rw-r--r-- | src/bitflags/lib.rs.html | 1121 |
1 files changed, 1121 insertions, 0 deletions
diff --git a/src/bitflags/lib.rs.html b/src/bitflags/lib.rs.html new file mode 100644 index 0000000..83312e8 --- /dev/null +++ b/src/bitflags/lib.rs.html @@ -0,0 +1,1121 @@ +<!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 `/home/travis/.cargo/registry/src/github.com-0a35038f75765ae4/bitflags-0.2.1/src/lib.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>lib.rs.html -- source</title> + + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <section class="sidebar"> + + + </section> + + <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 source"><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> +<span id="477">477</span> +<span id="478">478</span> +<span id="479">479</span> +<span id="480">480</span> +<span id="481">481</span> +<span id="482">482</span> +<span id="483">483</span> +<span id="484">484</span> +<span id="485">485</span> +<span id="486">486</span> +<span id="487">487</span> +<span id="488">488</span> +<span id="489">489</span> +<span id="490">490</span> +<span id="491">491</span> +<span id="492">492</span> +<span id="493">493</span> +<span id="494">494</span> +<span id="495">495</span> +<span id="496">496</span> +<span id="497">497</span> +<span id="498">498</span> +<span id="499">499</span> +<span id="500">500</span> +<span id="501">501</span> +<span id="502">502</span> +<span id="503">503</span> +<span id="504">504</span> +<span id="505">505</span> +<span id="506">506</span> +<span id="507">507</span> +<span id="508">508</span> +<span id="509">509</span> +<span id="510">510</span> +<span id="511">511</span> +<span id="512">512</span> +</pre><pre class='rust '> +<span class='comment'>// Copyright 2014 The Rust Project Developers. See the COPYRIGHT</span> +<span class='comment'>// file at the top-level directory of this distribution and at</span> +<span class='comment'>// http://rust-lang.org/COPYRIGHT.</span> +<span class='comment'>//</span> +<span class='comment'>// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> +<span class='comment'>// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> +<span class='comment'>// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> +<span class='comment'>// option. This file may not be copied, modified, or distributed</span> +<span class='comment'>// except according to those terms.</span> + +<span class='doccomment'>//! A typesafe bitmask flag generator.</span> + +<span class='doccomment'>/// The `bitflags!` macro generates a `struct` that holds a set of C-style</span> +<span class='doccomment'>/// bitmask flags. It is useful for creating typesafe wrappers for C APIs.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The flags should only be defined for integer types, otherwise unexpected</span> +<span class='doccomment'>/// type errors may occur at compile time.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Example</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ```{.rust}</span> +<span class='doccomment'>/// #[macro_use]</span> +<span class='doccomment'>/// extern crate bitflags;</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// bitflags! {</span> +<span class='doccomment'>/// flags Flags: u32 {</span> +<span class='doccomment'>/// const FLAG_A = 0b00000001,</span> +<span class='doccomment'>/// const FLAG_B = 0b00000010,</span> +<span class='doccomment'>/// const FLAG_C = 0b00000100,</span> +<span class='doccomment'>/// const FLAG_ABC = FLAG_A.bits</span> +<span class='doccomment'>/// | FLAG_B.bits</span> +<span class='doccomment'>/// | FLAG_C.bits,</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// fn main() {</span> +<span class='doccomment'>/// let e1 = FLAG_A | FLAG_C;</span> +<span class='doccomment'>/// let e2 = FLAG_B | FLAG_C;</span> +<span class='doccomment'>/// assert!((e1 | e2) == FLAG_ABC); // union</span> +<span class='doccomment'>/// assert!((e1 & e2) == FLAG_C); // intersection</span> +<span class='doccomment'>/// assert!((e1 - e2) == FLAG_A); // set difference</span> +<span class='doccomment'>/// assert!(!e2 == FLAG_A); // set complement</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The generated `struct`s can also be extended with type and trait</span> +<span class='doccomment'>/// implementations:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// ```{.rust}</span> +<span class='doccomment'>/// #[macro_use]</span> +<span class='doccomment'>/// extern crate bitflags;</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// use std::fmt;</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// bitflags! {</span> +<span class='doccomment'>/// flags Flags: u32 {</span> +<span class='doccomment'>/// const FLAG_A = 0b00000001,</span> +<span class='doccomment'>/// const FLAG_B = 0b00000010,</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// impl Flags {</span> +<span class='doccomment'>/// pub fn clear(&mut self) {</span> +<span class='doccomment'>/// self.bits = 0; // The `bits` field can be accessed from within the</span> +<span class='doccomment'>/// // same module where the `bitflags!` macro was invoked.</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// impl fmt::Display for Flags {</span> +<span class='doccomment'>/// fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {</span> +<span class='doccomment'>/// write!(f, "hi!")</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// fn main() {</span> +<span class='doccomment'>/// let mut flags = FLAG_A | FLAG_B;</span> +<span class='doccomment'>/// flags.clear();</span> +<span class='doccomment'>/// assert!(flags.is_empty());</span> +<span class='doccomment'>/// assert_eq!(format!("{}", flags), "hi!");</span> +<span class='doccomment'>/// assert_eq!(format!("{:?}", FLAG_A | FLAG_B), "Flags { bits: 0b11 }");</span> +<span class='doccomment'>/// assert_eq!(format!("{:?}", FLAG_B), "Flags { bits: 0b10 }");</span> +<span class='doccomment'>/// }</span> +<span class='doccomment'>/// ```</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Attributes</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// Attributes can be attached to the generated `struct` by placing them</span> +<span class='doccomment'>/// before the `flags` keyword.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Derived traits</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The `PartialEq` and `Clone` traits are automatically derived for the</span> +<span class='doccomment'>/// `struct` using the `deriving` attribute. Additional traits can be derived by</span> +<span class='doccomment'>/// providing an explicit `deriving` attribute on `flags`. The `Debug` trait is</span> +<span class='doccomment'>/// also implemented by displaying the bits value of the internal struct.</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Operators</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The following operator traits are implemented for the generated `struct`:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// - `BitOr`: union</span> +<span class='doccomment'>/// - `BitAnd`: intersection</span> +<span class='doccomment'>/// - `BitXor`: toggle</span> +<span class='doccomment'>/// - `Sub`: set difference</span> +<span class='doccomment'>/// - `Not`: set complement</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// # Methods</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// The following methods are defined for the generated `struct`:</span> +<span class='doccomment'>///</span> +<span class='doccomment'>/// - `empty`: an empty set of flags</span> +<span class='doccomment'>/// - `all`: the set of all flags</span> +<span class='doccomment'>/// - `bits`: the raw value of the flags currently stored</span> +<span class='doccomment'>/// - `from_bits`: convert from underlying bit representation, unless that</span> +<span class='doccomment'>/// representation contains bits that do not correspond to a flag</span> +<span class='doccomment'>/// - `from_bits_truncate`: convert from underlying bit representation, dropping</span> +<span class='doccomment'>/// any bits that do not correspond to flags</span> +<span class='doccomment'>/// - `is_empty`: `true` if no flags are currently stored</span> +<span class='doccomment'>/// - `is_all`: `true` if all flags are currently set</span> +<span class='doccomment'>/// - `intersects`: `true` if there are flags common to both `self` and `other`</span> +<span class='doccomment'>/// - `contains`: `true` all of the flags in `other` are contained within `self`</span> +<span class='doccomment'>/// - `insert`: inserts the specified flags in-place</span> +<span class='doccomment'>/// - `remove`: removes the specified flags in-place</span> +<span class='doccomment'>/// - `toggle`: the specified flags will be inserted if not present, and removed</span> +<span class='doccomment'>/// if they are.</span> +<span class='attribute'>#[<span class='ident'>macro_export</span>]</span> +<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>bitflags</span> { + ($(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>attr</span>:<span class='ident'>meta</span>]</span>)<span class='op'>*</span> <span class='ident'>flags</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>:<span class='ident'>ident</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>T</span>:<span class='ident'>ty</span> { + $($(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag_attr</span>:<span class='ident'>meta</span>]</span>)<span class='op'>*</span> <span class='kw'>const</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag</span>:<span class='ident'>ident</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>value</span>:<span class='ident'>expr</span>),<span class='op'>+</span> + }) <span class='op'>=></span> { + <span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Copy</span>, <span class='ident'>PartialEq</span>, <span class='ident'>Eq</span>, <span class='ident'>Clone</span>, <span class='ident'>PartialOrd</span>, <span class='ident'>Ord</span>, <span class='ident'>Hash</span>)]</span> + $(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>attr</span>]</span>)<span class='op'>*</span> + <span class='kw'>pub</span> <span class='kw'>struct</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='ident'>bits</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>T</span>, + } + + $($(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag_attr</span>]</span>)<span class='op'>*</span> <span class='kw'>pub</span> <span class='kw'>const</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>value</span> };)<span class='op'>+</span> + + <span class='kw'>impl</span> ::<span class='ident'>std</span>::<span class='ident'>fmt</span>::<span class='ident'>Debug</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='kw'>fn</span> <span class='ident'>fmt</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>f</span>: <span class='kw-2'>&</span><span class='kw-2'>mut</span> ::<span class='ident'>std</span>::<span class='ident'>fmt</span>::<span class='ident'>Formatter</span>) <span class='op'>-></span> ::<span class='ident'>std</span>::<span class='ident'>fmt</span>::<span class='prelude-ty'>Result</span> { + <span class='kw'>let</span> <span class='ident'>out</span> <span class='op'>=</span> <span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"{} {{ bits: {:#b} }}"</span>, + <span class='macro'>stringify</span><span class='macro'>!</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>), + <span class='self'>self</span>.<span class='ident'>bits</span>); + <span class='ident'>f</span>.<span class='ident'>write_str</span>(<span class='kw-2'>&</span><span class='ident'>out</span>[..]) + } + } + + <span class='kw'>impl</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='doccomment'>/// Returns an empty set of flags.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>empty</span>() <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='number'>0</span> } + } + + <span class='doccomment'>/// Returns the set containing all flags.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>all</span>() <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>value</span>)<span class='op'>|</span><span class='op'>+</span> } + } + + <span class='doccomment'>/// Returns the raw value of the flags currently stored.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>bits</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>T</span> { + <span class='self'>self</span>.<span class='ident'>bits</span> + } + + <span class='doccomment'>/// Convert from underlying bit representation, unless that</span> + <span class='doccomment'>/// representation contains bits that do not correspond to a flag.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>from_bits</span>(<span class='ident'>bits</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>T</span>) <span class='op'>-></span> ::<span class='ident'>std</span>::<span class='ident'>option</span>::<span class='prelude-ty'>Option</span><span class='op'><</span><span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span><span class='op'>></span> { + <span class='kw'>if</span> (<span class='ident'>bits</span> <span class='kw-2'>&</span> <span class='op'>!</span><span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>::<span class='ident'>all</span>().<span class='ident'>bits</span>()) <span class='op'>!=</span> <span class='number'>0</span> { + ::<span class='ident'>std</span>::<span class='ident'>option</span>::<span class='prelude-ty'>Option</span>::<span class='prelude-val'>None</span> + } <span class='kw'>else</span> { + ::<span class='ident'>std</span>::<span class='ident'>option</span>::<span class='prelude-ty'>Option</span>::<span class='prelude-val'>Some</span>(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='ident'>bits</span> }) + } + } + + <span class='doccomment'>/// Convert from underlying bit representation, dropping any bits</span> + <span class='doccomment'>/// that do not correspond to flags.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>from_bits_truncate</span>(<span class='ident'>bits</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>T</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='ident'>bits</span> } <span class='kw-2'>&</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>::<span class='ident'>all</span>() + } + + <span class='doccomment'>/// Returns `true` if no flags are currently stored.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_empty</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='op'>*</span><span class='self'>self</span> <span class='op'>==</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>::<span class='ident'>empty</span>() + } + + <span class='doccomment'>/// Returns `true` if all flags are currently set.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_all</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='op'>*</span><span class='self'>self</span> <span class='op'>==</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>::<span class='ident'>all</span>() + } + + <span class='doccomment'>/// Returns `true` if there are flags common to both `self` and `other`.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>intersects</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='op'>!</span>(<span class='op'>*</span><span class='self'>self</span> <span class='kw-2'>&</span> <span class='ident'>other</span>).<span class='ident'>is_empty</span>() + } + + <span class='doccomment'>/// Returns `true` all of the flags in `other` are contained within `self`.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>contains</span>(<span class='kw-2'>&</span><span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + (<span class='op'>*</span><span class='self'>self</span> <span class='kw-2'>&</span> <span class='ident'>other</span>) <span class='op'>==</span> <span class='ident'>other</span> + } + + <span class='doccomment'>/// Inserts the specified flags in-place.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>insert</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) { + <span class='self'>self</span>.<span class='ident'>bits</span> <span class='op'>|=</span> <span class='ident'>other</span>.<span class='ident'>bits</span>; + } + + <span class='doccomment'>/// Removes the specified flags in-place.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>remove</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) { + <span class='self'>self</span>.<span class='ident'>bits</span> <span class='op'>&=</span> <span class='op'>!</span><span class='ident'>other</span>.<span class='ident'>bits</span>; + } + + <span class='doccomment'>/// Toggles the specified flags in-place.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>toggle</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) { + <span class='self'>self</span>.<span class='ident'>bits</span> <span class='op'>^=</span> <span class='ident'>other</span>.<span class='ident'>bits</span>; + } + } + + <span class='kw'>impl</span> ::<span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>BitOr</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='kw'>type</span> <span class='ident'>Output</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>; + + <span class='doccomment'>/// Returns the union of the two sets of flags.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>bitor</span>(<span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='self'>self</span>.<span class='ident'>bits</span> <span class='op'>|</span> <span class='ident'>other</span>.<span class='ident'>bits</span> } + } + } + + <span class='kw'>impl</span> ::<span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>BitXor</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='kw'>type</span> <span class='ident'>Output</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>; + + <span class='doccomment'>/// Returns the left flags, but with all the right flags toggled.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>bitxor</span>(<span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='self'>self</span>.<span class='ident'>bits</span> <span class='op'>^</span> <span class='ident'>other</span>.<span class='ident'>bits</span> } + } + } + + <span class='kw'>impl</span> ::<span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>BitAnd</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='kw'>type</span> <span class='ident'>Output</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>; + + <span class='doccomment'>/// Returns the intersection between the two sets of flags.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>bitand</span>(<span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='self'>self</span>.<span class='ident'>bits</span> <span class='kw-2'>&</span> <span class='ident'>other</span>.<span class='ident'>bits</span> } + } + } + + <span class='kw'>impl</span> ::<span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Sub</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='kw'>type</span> <span class='ident'>Output</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>; + + <span class='doccomment'>/// Returns the set difference of the two sets of flags.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>sub</span>(<span class='self'>self</span>, <span class='ident'>other</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='self'>self</span>.<span class='ident'>bits</span> <span class='kw-2'>&</span> <span class='op'>!</span><span class='ident'>other</span>.<span class='ident'>bits</span> } + } + } + + <span class='kw'>impl</span> ::<span class='ident'>std</span>::<span class='ident'>ops</span>::<span class='ident'>Not</span> <span class='kw'>for</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='kw'>type</span> <span class='ident'>Output</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>; + + <span class='doccomment'>/// Returns the complement of this set of flags.</span> + <span class='attribute'>#[<span class='ident'>inline</span>]</span> + <span class='kw'>fn</span> <span class='ident'>not</span>(<span class='self'>self</span>) <span class='op'>-></span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { + <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span> { <span class='ident'>bits</span>: <span class='op'>!</span><span class='self'>self</span>.<span class='ident'>bits</span> } <span class='kw-2'>&</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>::<span class='ident'>all</span>() + } + } + }; + ($(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>attr</span>:<span class='ident'>meta</span>]</span>)<span class='op'>*</span> <span class='ident'>flags</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>:<span class='ident'>ident</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>T</span>:<span class='ident'>ty</span> { + $($(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag_attr</span>:<span class='ident'>meta</span>]</span>)<span class='op'>*</span> <span class='kw'>const</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag</span>:<span class='ident'>ident</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>value</span>:<span class='ident'>expr</span>),<span class='op'>+</span>, + }) <span class='op'>=></span> { + <span class='macro'>bitflags</span><span class='macro'>!</span> { + $(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>attr</span>]</span>)<span class='op'>*</span> + <span class='ident'>flags</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>BitFlags</span>: <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>T</span> { + $($(<span class='attribute'>#[<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag_attr</span>]</span>)<span class='op'>*</span> <span class='kw'>const</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>Flag</span> <span class='op'>=</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>value</span>),<span class='op'>+</span> + } + } + }; +} + +<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>test</span>)]</span> +<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>non_upper_case_globals</span>, <span class='ident'>dead_code</span>)]</span> +<span class='kw'>mod</span> <span class='ident'>tests</span> { + <span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>hash</span>::{<span class='ident'>SipHasher</span>, <span class='ident'>Hash</span>, <span class='ident'>Hasher</span>}; + + <span class='macro'>bitflags</span><span class='macro'>!</span> { + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"> The first principle is that you must not fool yourself — and"</span>]</span> + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"> you are the easiest person to fool."</span>]</span> + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"> "</span>]</span> + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"> - Richard Feynman"</span>]</span> + <span class='ident'>flags</span> <span class='ident'>Flags</span>: <span class='ident'>u32</span> { + <span class='kw'>const</span> <span class='ident'>FlagA</span> <span class='op'>=</span> <span class='number'>0b00000001</span>, + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"<pcwalton> macros are way better at generating code than trans is"</span>]</span> + <span class='kw'>const</span> <span class='ident'>FlagB</span> <span class='op'>=</span> <span class='number'>0b00000010</span>, + <span class='kw'>const</span> <span class='ident'>FlagC</span> <span class='op'>=</span> <span class='number'>0b00000100</span>, + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"* cmr bed"</span>]</span> + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"* strcat table"</span>]</span> + <span class='attribute'>#[<span class='ident'>doc</span> <span class='op'>=</span> <span class='string'>"<strcat> wait what?"</span>]</span> + <span class='kw'>const</span> <span class='ident'>FlagABC</span> <span class='op'>=</span> <span class='ident'>FlagA</span>.<span class='ident'>bits</span> + <span class='op'>|</span> <span class='ident'>FlagB</span>.<span class='ident'>bits</span> + <span class='op'>|</span> <span class='ident'>FlagC</span>.<span class='ident'>bits</span>, + } + } + + <span class='macro'>bitflags</span><span class='macro'>!</span> { + <span class='ident'>flags</span> <span class='ident'>_CfgFlags</span>: <span class='ident'>u32</span> { + <span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>windows</span>)]</span> + <span class='kw'>const</span> <span class='ident'>_CfgA</span> <span class='op'>=</span> <span class='number'>0b01</span>, + <span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>unix</span>)]</span> + <span class='kw'>const</span> <span class='ident'>_CfgB</span> <span class='op'>=</span> <span class='number'>0b01</span>, + } + } + + <span class='macro'>bitflags</span><span class='macro'>!</span> { + <span class='ident'>flags</span> <span class='ident'>AnotherSetOfFlags</span>: <span class='ident'>i8</span> { + <span class='kw'>const</span> <span class='ident'>AnotherFlag</span> <span class='op'>=</span> <span class='op'>-</span><span class='number'>1_i8</span>, + } + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_bits</span>(){ + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>empty</span>().<span class='ident'>bits</span>(), <span class='number'>0b00000000</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>FlagA</span>.<span class='ident'>bits</span>(), <span class='number'>0b00000001</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>FlagABC</span>.<span class='ident'>bits</span>(), <span class='number'>0b00000111</span>); + + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>empty</span>().<span class='ident'>bits</span>(), <span class='number'>0b00</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>AnotherFlag</span>.<span class='ident'>bits</span>(), <span class='op'>!</span><span class='number'>0_i8</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_from_bits</span>() { + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits</span>(<span class='number'>0</span>) <span class='op'>==</span> <span class='prelude-val'>Some</span>(<span class='ident'>Flags</span>::<span class='ident'>empty</span>())); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits</span>(<span class='number'>0b1</span>) <span class='op'>==</span> <span class='prelude-val'>Some</span>(<span class='ident'>FlagA</span>)); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits</span>(<span class='number'>0b10</span>) <span class='op'>==</span> <span class='prelude-val'>Some</span>(<span class='ident'>FlagB</span>)); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits</span>(<span class='number'>0b11</span>) <span class='op'>==</span> <span class='prelude-val'>Some</span>(<span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>)); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits</span>(<span class='number'>0b1000</span>) <span class='op'>==</span> <span class='prelude-val'>None</span>); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>from_bits</span>(<span class='op'>!</span><span class='number'>0_i8</span>) <span class='op'>==</span> <span class='prelude-val'>Some</span>(<span class='ident'>AnotherFlag</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_from_bits_truncate</span>() { + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits_truncate</span>(<span class='number'>0</span>) <span class='op'>==</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>()); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits_truncate</span>(<span class='number'>0b1</span>) <span class='op'>==</span> <span class='ident'>FlagA</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits_truncate</span>(<span class='number'>0b10</span>) <span class='op'>==</span> <span class='ident'>FlagB</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits_truncate</span>(<span class='number'>0b11</span>) <span class='op'>==</span> (<span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>)); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits_truncate</span>(<span class='number'>0b1000</span>) <span class='op'>==</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>()); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>from_bits_truncate</span>(<span class='number'>0b1001</span>) <span class='op'>==</span> <span class='ident'>FlagA</span>); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>from_bits_truncate</span>(<span class='number'>0_i8</span>) <span class='op'>==</span> <span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>empty</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_is_empty</span>(){ + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>empty</span>().<span class='ident'>is_empty</span>()); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>FlagA</span>.<span class='ident'>is_empty</span>()); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>FlagABC</span>.<span class='ident'>is_empty</span>()); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>AnotherFlag</span>.<span class='ident'>is_empty</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_is_all</span>() { + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>Flags</span>::<span class='ident'>all</span>().<span class='ident'>is_all</span>()); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>FlagA</span>.<span class='ident'>is_all</span>()); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>FlagABC</span>.<span class='ident'>is_all</span>()); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>AnotherFlag</span>.<span class='ident'>is_all</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_two_empties_do_not_intersect</span>() { + <span class='kw'>let</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>e1</span>.<span class='ident'>intersects</span>(<span class='ident'>e2</span>)); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>AnotherFlag</span>.<span class='ident'>intersects</span>(<span class='ident'>AnotherFlag</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_empty_does_not_intersect_with_full</span>() { + <span class='kw'>let</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>FlagABC</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>e1</span>.<span class='ident'>intersects</span>(<span class='ident'>e2</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_disjoint_intersects</span>() { + <span class='kw'>let</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>FlagA</span>; + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>FlagB</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>e1</span>.<span class='ident'>intersects</span>(<span class='ident'>e2</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_overlapping_intersects</span>() { + <span class='kw'>let</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>FlagA</span>; + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e1</span>.<span class='ident'>intersects</span>(<span class='ident'>e2</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_contains</span>() { + <span class='kw'>let</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>FlagA</span>; + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>e1</span>.<span class='ident'>contains</span>(<span class='ident'>e2</span>)); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e2</span>.<span class='ident'>contains</span>(<span class='ident'>e1</span>)); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>FlagABC</span>.<span class='ident'>contains</span>(<span class='ident'>e2</span>)); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>AnotherFlag</span>.<span class='ident'>contains</span>(<span class='ident'>AnotherFlag</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_insert</span>(){ + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>FlagA</span>; + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>; + <span class='ident'>e1</span>.<span class='ident'>insert</span>(<span class='ident'>e2</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e1</span> <span class='op'>==</span> <span class='ident'>e2</span>); + + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>e3</span> <span class='op'>=</span> <span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>empty</span>(); + <span class='ident'>e3</span>.<span class='ident'>insert</span>(<span class='ident'>AnotherFlag</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e3</span> <span class='op'>==</span> <span class='ident'>AnotherFlag</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_remove</span>(){ + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>; + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagC</span>; + <span class='ident'>e1</span>.<span class='ident'>remove</span>(<span class='ident'>e2</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e1</span> <span class='op'>==</span> <span class='ident'>FlagB</span>); + + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>e3</span> <span class='op'>=</span> <span class='ident'>AnotherFlag</span>; + <span class='ident'>e3</span>.<span class='ident'>remove</span>(<span class='ident'>AnotherFlag</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e3</span> <span class='op'>==</span> <span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>empty</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_operators</span>() { + <span class='kw'>let</span> <span class='ident'>e1</span> <span class='op'>=</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagC</span>; + <span class='kw'>let</span> <span class='ident'>e2</span> <span class='op'>=</span> <span class='ident'>FlagB</span> <span class='op'>|</span> <span class='ident'>FlagC</span>; + <span class='macro'>assert</span><span class='macro'>!</span>((<span class='ident'>e1</span> <span class='op'>|</span> <span class='ident'>e2</span>) <span class='op'>==</span> <span class='ident'>FlagABC</span>); <span class='comment'>// union</span> + <span class='macro'>assert</span><span class='macro'>!</span>((<span class='ident'>e1</span> <span class='kw-2'>&</span> <span class='ident'>e2</span>) <span class='op'>==</span> <span class='ident'>FlagC</span>); <span class='comment'>// intersection</span> + <span class='macro'>assert</span><span class='macro'>!</span>((<span class='ident'>e1</span> <span class='op'>-</span> <span class='ident'>e2</span>) <span class='op'>==</span> <span class='ident'>FlagA</span>); <span class='comment'>// set difference</span> + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>e2</span> <span class='op'>==</span> <span class='ident'>FlagA</span>); <span class='comment'>// set complement</span> + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e1</span> <span class='op'>^</span> <span class='ident'>e2</span> <span class='op'>==</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>); <span class='comment'>// toggle</span> + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>e3</span> <span class='op'>=</span> <span class='ident'>e1</span>; + <span class='ident'>e3</span>.<span class='ident'>toggle</span>(<span class='ident'>e2</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>e3</span> <span class='op'>==</span> <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>); + + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>m4</span> <span class='op'>=</span> <span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>empty</span>(); + <span class='ident'>m4</span>.<span class='ident'>toggle</span>(<span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>empty</span>()); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>m4</span> <span class='op'>==</span> <span class='ident'>AnotherSetOfFlags</span>::<span class='ident'>empty</span>()); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_lt</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span>(<span class='ident'>a</span> <span class='op'><</span> <span class='ident'>b</span>) <span class='op'>&&</span> <span class='op'>!</span>(<span class='ident'>b</span> <span class='op'><</span> <span class='ident'>a</span>)); + <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>FlagB</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>a</span> <span class='op'><</span> <span class='ident'>b</span>); + <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>FlagC</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span>(<span class='ident'>a</span> <span class='op'><</span> <span class='ident'>b</span>) <span class='op'>&&</span> <span class='ident'>b</span> <span class='op'><</span> <span class='ident'>a</span>); + <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>FlagC</span> <span class='op'>|</span> <span class='ident'>FlagB</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>a</span> <span class='op'><</span> <span class='ident'>b</span>); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_ord</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>a</span> <span class='op'><=</span> <span class='ident'>b</span> <span class='op'>&&</span> <span class='ident'>a</span> <span class='op'>>=</span> <span class='ident'>b</span>); + <span class='ident'>a</span> <span class='op'>=</span> <span class='ident'>FlagA</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>a</span> <span class='op'>></span> <span class='ident'>b</span> <span class='op'>&&</span> <span class='ident'>a</span> <span class='op'>>=</span> <span class='ident'>b</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>b</span> <span class='op'><</span> <span class='ident'>a</span> <span class='op'>&&</span> <span class='ident'>b</span> <span class='op'><=</span> <span class='ident'>a</span>); + <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>FlagB</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>b</span> <span class='op'>></span> <span class='ident'>a</span> <span class='op'>&&</span> <span class='ident'>b</span> <span class='op'>>=</span> <span class='ident'>a</span>); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>a</span> <span class='op'><</span> <span class='ident'>b</span> <span class='op'>&&</span> <span class='ident'>a</span> <span class='op'><=</span> <span class='ident'>b</span>); + } + + <span class='kw'>fn</span> <span class='ident'>hash</span><span class='op'><</span><span class='ident'>T</span>: <span class='ident'>Hash</span><span class='op'>></span>(<span class='ident'>t</span>: <span class='kw-2'>&</span><span class='ident'>T</span>) <span class='op'>-></span> <span class='ident'>u64</span> { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='ident'>SipHasher</span>::<span class='ident'>new_with_keys</span>(<span class='number'>0</span>, <span class='number'>0</span>); + <span class='ident'>t</span>.<span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>s</span>); + <span class='ident'>s</span>.<span class='ident'>finish</span>() + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_hash</span>() { + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + <span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>y</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>empty</span>(); + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>x</span>) <span class='op'>==</span> <span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>y</span>)); + <span class='ident'>x</span> <span class='op'>=</span> <span class='ident'>Flags</span>::<span class='ident'>all</span>(); + <span class='ident'>y</span> <span class='op'>=</span> <span class='ident'>FlagABC</span>; + <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>x</span>) <span class='op'>==</span> <span class='ident'>hash</span>(<span class='kw-2'>&</span><span class='ident'>y</span>)); + } + + <span class='attribute'>#[<span class='ident'>test</span>]</span> + <span class='kw'>fn</span> <span class='ident'>test_debug</span>() { + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"{:?}"</span>, <span class='ident'>FlagA</span> <span class='op'>|</span> <span class='ident'>FlagB</span>), <span class='string'>"Flags { bits: 0b11 }"</span>); + <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"{:?}"</span>, <span class='ident'>FlagABC</span>), <span class='string'>"Flags { bits: 0b111 }"</span>); + } +} +</pre> +</section> + <section id='search' class="content hidden"></section> + + <section class="footer"></section> + + <div id="help" class="hidden"> + <div class="shortcuts"> + <h1>Keyboard shortcuts</h1> + <dl> + <dt>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</dd> + </dl> + </div> + <div class="infos"> + <h1>Search tricks</h1> + <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>typedef</code> (or + <code>tdef</code>). + </p> + <p> + Search functions by type signature (e.g. + <code>vec -> usize</code>) + </p> + </div> + </div> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "bitflags"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script async src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |