| <!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 of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/uuid-0.8.2/src/builder/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../uuid/index.html"><div class="logo-container"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../uuid/index.html"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2013-2014 The Rust Project Developers. |
| // Copyright 2018 The Uuid Project Developers. |
| // |
| // See the COPYRIGHT file at the top-level directory of this distribution. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| </span><span class="doccomment">//! A Builder type for [`Uuid`]s. |
| //! |
| //! [`Uuid`]: ../struct.Uuid.html |
| |
| </span><span class="kw">mod </span>error; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::error::Error; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>; |
| |
| <span class="kw">impl </span>Uuid { |
| <span class="doccomment">/// The 'nil UUID'. |
| /// |
| /// The nil UUID is special form of UUID that is specified to have all |
| /// 128 bits set to zero, as defined in [IETF RFC 4122 Section 4.1.7][RFC]. |
| /// |
| /// [RFC]: https://tools.ietf.org/html/rfc4122.html#section-4.1.7 |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use uuid::Uuid; |
| /// |
| /// let uuid = Uuid::nil(); |
| /// |
| /// assert_eq!( |
| /// uuid.to_hyphenated().to_string(), |
| /// "00000000-0000-0000-0000-000000000000" |
| /// ); |
| /// ``` |
| </span><span class="kw">pub const fn </span>nil() -> <span class="self">Self </span>{ |
| Uuid::from_bytes([<span class="number">0</span>; <span class="number">16</span>]) |
| } |
| |
| <span class="doccomment">/// Creates a UUID from four field values in big-endian order. |
| /// |
| /// # Errors |
| /// |
| /// This function will return an error if `d4`'s length is not 8 bytes. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use uuid::Uuid; |
| /// |
| /// let d4 = [12, 3, 9, 56, 54, 43, 8, 9]; |
| /// |
| /// let uuid = Uuid::from_fields(42, 12, 5, &d4); |
| /// let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string()); |
| /// |
| /// let expected_uuid = |
| /// Ok(String::from("0000002a-000c-0005-0c03-0938362b0809")); |
| /// |
| /// assert_eq!(expected_uuid, uuid); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_fields( |
| d1: u32, |
| d2: u16, |
| d3: u16, |
| d4: <span class="kw-2">&</span>[u8], |
| ) -> <span class="prelude-ty">Result</span><Uuid, <span class="kw">crate</span>::Error> { |
| <span class="kw">const </span>D4_LEN: usize = <span class="number">8</span>; |
| |
| <span class="kw">let </span>len = d4.len(); |
| |
| <span class="kw">if </span>len != D4_LEN { |
| <span class="prelude-val">Err</span>(Error::new(D4_LEN, len))<span class="question-mark">?</span>; |
| } |
| |
| <span class="prelude-val">Ok</span>(Uuid::from_bytes([ |
| (d1 >> <span class="number">24</span>) <span class="kw">as </span>u8, |
| (d1 >> <span class="number">16</span>) <span class="kw">as </span>u8, |
| (d1 >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| d1 <span class="kw">as </span>u8, |
| (d2 >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| d2 <span class="kw">as </span>u8, |
| (d3 >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| d3 <span class="kw">as </span>u8, |
| d4[<span class="number">0</span>], |
| d4[<span class="number">1</span>], |
| d4[<span class="number">2</span>], |
| d4[<span class="number">3</span>], |
| d4[<span class="number">4</span>], |
| d4[<span class="number">5</span>], |
| d4[<span class="number">6</span>], |
| d4[<span class="number">7</span>], |
| ])) |
| } |
| |
| <span class="doccomment">/// Creates a UUID from four field values in little-endian order. |
| /// |
| /// The bytes in the `d1`, `d2` and `d3` fields will |
| /// be converted into big-endian order. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use uuid::Uuid; |
| /// |
| /// let d1 = 0xAB3F1097u32; |
| /// let d2 = 0x501Eu16; |
| /// let d3 = 0xB736u16; |
| /// let d4 = [12, 3, 9, 56, 54, 43, 8, 9]; |
| /// |
| /// let uuid = Uuid::from_fields_le(d1, d2, d3, &d4); |
| /// let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string()); |
| /// |
| /// let expected_uuid = |
| /// Ok(String::from("97103fab-1e50-36b7-0c03-0938362b0809")); |
| /// |
| /// assert_eq!(expected_uuid, uuid); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_fields_le( |
| d1: u32, |
| d2: u16, |
| d3: u16, |
| d4: <span class="kw-2">&</span>[u8], |
| ) -> <span class="prelude-ty">Result</span><Uuid, <span class="kw">crate</span>::Error> { |
| <span class="kw">const </span>D4_LEN: usize = <span class="number">8</span>; |
| |
| <span class="kw">let </span>len = d4.len(); |
| |
| <span class="kw">if </span>len != D4_LEN { |
| <span class="prelude-val">Err</span>(Error::new(D4_LEN, len))<span class="question-mark">?</span>; |
| } |
| |
| <span class="prelude-val">Ok</span>(Uuid::from_bytes([ |
| d1 <span class="kw">as </span>u8, |
| (d1 >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| (d1 >> <span class="number">16</span>) <span class="kw">as </span>u8, |
| (d1 >> <span class="number">24</span>) <span class="kw">as </span>u8, |
| (d2) <span class="kw">as </span>u8, |
| (d2 >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| d3 <span class="kw">as </span>u8, |
| (d3 >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| d4[<span class="number">0</span>], |
| d4[<span class="number">1</span>], |
| d4[<span class="number">2</span>], |
| d4[<span class="number">3</span>], |
| d4[<span class="number">4</span>], |
| d4[<span class="number">5</span>], |
| d4[<span class="number">6</span>], |
| d4[<span class="number">7</span>], |
| ])) |
| } |
| |
| <span class="doccomment">/// Creates a UUID from a 128bit value in big-endian order. |
| </span><span class="kw">pub const fn </span>from_u128(v: u128) -> <span class="self">Self </span>{ |
| Uuid::from_bytes([ |
| (v >> <span class="number">120</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">112</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">104</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">96</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">88</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">80</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">72</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">64</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">56</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">48</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">40</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">32</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">24</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">16</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| v <span class="kw">as </span>u8, |
| ]) |
| } |
| |
| <span class="doccomment">/// Creates a UUID from a 128bit value in little-endian order. |
| </span><span class="kw">pub const fn </span>from_u128_le(v: u128) -> <span class="self">Self </span>{ |
| Uuid::from_bytes([ |
| v <span class="kw">as </span>u8, |
| (v >> <span class="number">8</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">16</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">24</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">32</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">40</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">48</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">56</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">64</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">72</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">80</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">88</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">96</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">104</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">112</span>) <span class="kw">as </span>u8, |
| (v >> <span class="number">120</span>) <span class="kw">as </span>u8, |
| ]) |
| } |
| |
| <span class="doccomment">/// Creates a UUID using the supplied big-endian bytes. |
| /// |
| /// # Errors |
| /// |
| /// This function will return an error if `b` has any length other than 16. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use uuid::Uuid; |
| /// |
| /// let bytes = [4, 54, 67, 12, 43, 2, 98, 76, 32, 50, 87, 5, 1, 33, 43, 87]; |
| /// |
| /// let uuid = Uuid::from_slice(&bytes); |
| /// let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string()); |
| /// |
| /// let expected_uuid = |
| /// Ok(String::from("0436430c-2b02-624c-2032-570501212b57")); |
| /// |
| /// assert_eq!(expected_uuid, uuid); |
| /// ``` |
| /// |
| /// An incorrect number of bytes: |
| /// |
| /// ``` |
| /// use uuid::Uuid; |
| /// |
| /// let bytes = [4, 54, 67, 12, 43, 2, 98, 76]; |
| /// |
| /// let uuid = Uuid::from_slice(&bytes); |
| /// |
| /// assert!(uuid.is_err()); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_slice(b: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><Uuid, <span class="kw">crate</span>::Error> { |
| <span class="kw">const </span>BYTES_LEN: usize = <span class="number">16</span>; |
| |
| <span class="kw">let </span>len = b.len(); |
| |
| <span class="kw">if </span>len != BYTES_LEN { |
| <span class="prelude-val">Err</span>(Error::new(BYTES_LEN, len))<span class="question-mark">?</span>; |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes: Bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| bytes.copy_from_slice(b); |
| <span class="prelude-val">Ok</span>(Uuid::from_bytes(bytes)) |
| } |
| |
| <span class="doccomment">/// Creates a UUID using the supplied big-endian bytes. |
| </span><span class="kw">pub const fn </span>from_bytes(bytes: Bytes) -> Uuid { |
| Uuid(bytes) |
| } |
| } |
| |
| <span class="doccomment">/// A builder struct for creating a UUID. |
| /// |
| /// # Examples |
| /// |
| /// Creating a v4 UUID from externally generated bytes: |
| /// |
| /// ``` |
| /// use uuid::{Builder, Variant, Version}; |
| /// |
| /// # let rng = || [ |
| /// # 70, 235, 208, 238, 14, 109, 67, 201, 185, 13, 204, 195, 90, |
| /// # 145, 63, 62, |
| /// # ]; |
| /// let random_bytes = rng(); |
| /// let uuid = Builder::from_bytes(random_bytes) |
| /// .set_variant(Variant::RFC4122) |
| /// .set_version(Version::Random) |
| /// .build(); |
| /// ``` |
| </span><span class="comment">// TODO: remove in 1.0.0 |
| </span><span class="attribute">#[allow(dead_code)] |
| #[deprecated] |
| </span><span class="kw">pub type </span>Builder = <span class="kw">crate</span>::Builder; |
| |
| <span class="kw">impl </span><span class="kw">crate</span>::Builder { |
| <span class="doccomment">/// Creates a `Builder` using the supplied big-endian bytes. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// let bytes: uuid::Bytes = [ |
| /// 70, 235, 208, 238, 14, 109, 67, 201, 185, 13, 204, 195, 90, 145, 63, 62, |
| /// ]; |
| /// |
| /// let mut builder = uuid::Builder::from_bytes(bytes); |
| /// let uuid = builder.build().to_hyphenated().to_string(); |
| /// |
| /// let expected_uuid = String::from("46ebd0ee-0e6d-43c9-b90d-ccc35a913f3e"); |
| /// |
| /// assert_eq!(expected_uuid, uuid); |
| /// ``` |
| /// |
| /// An incorrect number of bytes: |
| /// |
| /// ```compile_fail |
| /// let bytes: uuid::Bytes = [4, 54, 67, 12, 43, 2, 98, 76]; // doesn't compile |
| /// |
| /// let uuid = uuid::Builder::from_bytes(bytes); |
| /// ``` |
| </span><span class="kw">pub const fn </span>from_bytes(b: Bytes) -> <span class="self">Self </span>{ |
| Builder(b) |
| } |
| |
| <span class="doccomment">/// Creates a `Builder` using the supplied big-endian bytes. |
| /// |
| /// # Errors |
| /// |
| /// This function will return an error if `b` has any length other than 16. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// let bytes = [4, 54, 67, 12, 43, 2, 98, 76, 32, 50, 87, 5, 1, 33, 43, 87]; |
| /// |
| /// let builder = uuid::Builder::from_slice(&bytes); |
| /// let uuid = |
| /// builder.map(|mut builder| builder.build().to_hyphenated().to_string()); |
| /// |
| /// let expected_uuid = |
| /// Ok(String::from("0436430c-2b02-624c-2032-570501212b57")); |
| /// |
| /// assert_eq!(expected_uuid, uuid); |
| /// ``` |
| /// |
| /// An incorrect number of bytes: |
| /// |
| /// ``` |
| /// let bytes = [4, 54, 67, 12, 43, 2, 98, 76]; |
| /// |
| /// let builder = uuid::Builder::from_slice(&bytes); |
| /// |
| /// assert!(builder.is_err()); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_slice(b: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="kw">crate</span>::Error> { |
| <span class="kw">const </span>BYTES_LEN: usize = <span class="number">16</span>; |
| |
| <span class="kw">let </span>len = b.len(); |
| |
| <span class="kw">if </span>len != BYTES_LEN { |
| <span class="prelude-val">Err</span>(Error::new(BYTES_LEN, len))<span class="question-mark">?</span>; |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes: <span class="kw">crate</span>::Bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| bytes.copy_from_slice(b); |
| <span class="prelude-val">Ok</span>(<span class="self">Self</span>::from_bytes(bytes)) |
| } |
| |
| <span class="doccomment">/// Creates a `Builder` from four big-endian field values. |
| /// |
| /// # Errors |
| /// |
| /// This function will return an error if `d4`'s length is not 8 bytes. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// let d4 = [12, 3, 9, 56, 54, 43, 8, 9]; |
| /// |
| /// let builder = uuid::Builder::from_fields(42, 12, 5, &d4); |
| /// let uuid = |
| /// builder.map(|mut builder| builder.build().to_hyphenated().to_string()); |
| /// |
| /// let expected_uuid = |
| /// Ok(String::from("0000002a-000c-0005-0c03-0938362b0809")); |
| /// |
| /// assert_eq!(expected_uuid, uuid); |
| /// ``` |
| /// |
| /// An invalid length: |
| /// |
| /// ``` |
| /// let d4 = [12]; |
| /// |
| /// let builder = uuid::Builder::from_fields(42, 12, 5, &d4); |
| /// |
| /// assert!(builder.is_err()); |
| /// ``` |
| </span><span class="kw">pub fn </span>from_fields( |
| d1: u32, |
| d2: u16, |
| d3: u16, |
| d4: <span class="kw-2">&</span>[u8], |
| ) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="kw">crate</span>::Error> { |
| Uuid::from_fields(d1, d2, d3, d4).map(|uuid| { |
| <span class="kw">let </span>bytes = <span class="kw-2">*</span>uuid.as_bytes(); |
| |
| <span class="kw">crate</span>::Builder::from_bytes(bytes) |
| }) |
| } |
| |
| <span class="doccomment">/// Creates a `Builder` from a big-endian 128bit value. |
| </span><span class="kw">pub fn </span>from_u128(v: u128) -> <span class="self">Self </span>{ |
| <span class="kw">crate</span>::Builder::from_bytes(<span class="kw-2">*</span>Uuid::from_u128(v).as_bytes()) |
| } |
| |
| <span class="doccomment">/// Creates a `Builder` with an initial [`Uuid::nil`]. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use uuid::Builder; |
| /// |
| /// let mut builder = Builder::nil(); |
| /// |
| /// assert_eq!( |
| /// builder.build().to_hyphenated().to_string(), |
| /// "00000000-0000-0000-0000-000000000000" |
| /// ); |
| /// ``` |
| </span><span class="kw">pub const fn </span>nil() -> <span class="self">Self </span>{ |
| Builder([<span class="number">0</span>; <span class="number">16</span>]) |
| } |
| |
| <span class="doccomment">/// Specifies the variant of the UUID. |
| </span><span class="kw">pub fn </span>set_variant(<span class="kw-2">&mut </span><span class="self">self</span>, v: <span class="kw">crate</span>::Variant) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="kw">let </span>byte = <span class="self">self</span>.<span class="number">0</span>[<span class="number">8</span>]; |
| |
| <span class="self">self</span>.<span class="number">0</span>[<span class="number">8</span>] = <span class="kw">match </span>v { |
| <span class="kw">crate</span>::Variant::NCS => byte & <span class="number">0x7f</span>, |
| <span class="kw">crate</span>::Variant::RFC4122 => (byte & <span class="number">0x3f</span>) | <span class="number">0x80</span>, |
| <span class="kw">crate</span>::Variant::Microsoft => (byte & <span class="number">0x1f</span>) | <span class="number">0xc0</span>, |
| <span class="kw">crate</span>::Variant::Future => (byte & <span class="number">0x1f</span>) | <span class="number">0xe0</span>, |
| }; |
| |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Specifies the version number of the UUID. |
| </span><span class="kw">pub fn </span>set_version(<span class="kw-2">&mut </span><span class="self">self</span>, v: <span class="kw">crate</span>::Version) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="self">self</span>.<span class="number">0</span>[<span class="number">6</span>] = (<span class="self">self</span>.<span class="number">0</span>[<span class="number">6</span>] & <span class="number">0x0f</span>) | ((v <span class="kw">as </span>u8) << <span class="number">4</span>); |
| |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Hands over the internal constructed [`Uuid`]. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use uuid::Builder; |
| /// |
| /// let uuid = Builder::nil().build(); |
| /// |
| /// assert_eq!( |
| /// uuid.to_hyphenated().to_string(), |
| /// "00000000-0000-0000-0000-000000000000" |
| /// ); |
| /// ``` |
| /// |
| /// [`Uuid`]: struct.Uuid.html |
| </span><span class="kw">pub fn </span>build(<span class="kw-2">&mut </span><span class="self">self</span>) -> Uuid { |
| Uuid::from_bytes(<span class="self">self</span>.<span class="number">0</span>) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="uuid" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
