| <!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/bytemuck-1.13.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></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="../../bytemuck/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../bytemuck/index.html"><img class="rust-logo" src="../../rust-logo.svg" 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> |
| </pre><pre class="rust"><code><span class="attribute">#![no_std] |
| #![warn(missing_docs)] |
| #![allow(clippy::match_like_matches_macro)] |
| #![allow(clippy::uninlined_format_args)] |
| #![cfg_attr(feature = <span class="string">"nightly_portable_simd"</span>, feature(portable_simd))] |
| #![cfg_attr(feature = <span class="string">"nightly_stdsimd"</span>, feature(stdsimd))] |
| |
| </span><span class="doccomment">//! This crate gives small utilities for casting between plain data types. |
| //! |
| //! ## Basics |
| //! |
| //! Data comes in five basic forms in Rust, so we have five basic casting |
| //! functions: |
| //! |
| //! * `T` uses [`cast`] |
| //! * `&T` uses [`cast_ref`] |
| //! * `&mut T` uses [`cast_mut`] |
| //! * `&[T]` uses [`cast_slice`] |
| //! * `&mut [T]` uses [`cast_slice_mut`] |
| //! |
| //! Some casts will never fail (eg: `cast::<u32, f32>` always works), other |
| //! casts might fail (eg: `cast_ref::<[u8; 4], u32>` will fail if the reference |
| //! isn't already aligned to 4). Each casting function has a "try" version which |
| //! will return a `Result`, and the "normal" version which will simply panic on |
| //! invalid input. |
| //! |
| //! ## Using Your Own Types |
| //! |
| //! All the functions here are guarded by the [`Pod`] trait, which is a |
| //! sub-trait of the [`Zeroable`] trait. |
| //! |
| //! If you're very sure that your type is eligible, you can implement those |
| //! traits for your type and then they'll have full casting support. However, |
| //! these traits are `unsafe`, and you should carefully read the requirements |
| //! before adding the them to your own types. |
| //! |
| //! ## Features |
| //! |
| //! * This crate is core only by default, but if you're using Rust 1.36 or later |
| //! you can enable the `extern_crate_alloc` cargo feature for some additional |
| //! methods related to `Box` and `Vec`. Note that the `docs.rs` documentation |
| //! is always built with `extern_crate_alloc` cargo feature enabled. |
| |
| </span><span class="attribute">#[cfg(all(target_arch = <span class="string">"aarch64"</span>, feature = <span class="string">"aarch64_simd"</span>))] |
| </span><span class="kw">use </span>core::arch::aarch64; |
| <span class="attribute">#[cfg(all(target_arch = <span class="string">"wasm32"</span>, feature = <span class="string">"wasm_simd"</span>))] |
| </span><span class="kw">use </span>core::arch::wasm32; |
| <span class="attribute">#[cfg(target_arch = <span class="string">"x86"</span>)] |
| </span><span class="kw">use </span>core::arch::x86; |
| <span class="attribute">#[cfg(target_arch = <span class="string">"x86_64"</span>)] |
| </span><span class="kw">use </span>core::arch::x86_64; |
| <span class="comment">// |
| </span><span class="kw">use </span>core::{marker::<span class="kw-2">*</span>, mem::<span class="kw-2">*</span>, num::<span class="kw-2">*</span>, ptr::<span class="kw-2">*</span>}; |
| |
| <span class="comment">// Used from macros to ensure we aren't using some locally defined name and |
| // actually are referencing libcore. This also would allow pre-2018 edition |
| // crates to use our macros, but I'm not sure how important that is. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub use </span>::core <span class="kw">as </span>__core; |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"min_const_generics"</span>))] |
| </span><span class="macro">macro_rules! </span>impl_unsafe_marker_for_array { |
| ( <span class="macro-nonterminal">$marker</span>:ident , $( <span class="macro-nonterminal">$n</span>:expr ),* ) => { |
| $(<span class="kw">unsafe impl</span><T> <span class="macro-nonterminal">$marker </span><span class="kw">for </span>[T; <span class="macro-nonterminal">$n</span>] <span class="kw">where </span>T: <span class="macro-nonterminal">$marker </span>{})* |
| } |
| } |
| |
| <span class="doccomment">/// A macro to transmute between two types without requiring knowing size |
| /// statically. |
| </span><span class="macro">macro_rules! </span>transmute { |
| (<span class="macro-nonterminal">$val</span>:expr) => { |
| ::core::mem::transmute_copy(<span class="kw-2">&</span>::core::mem::ManuallyDrop::new(<span class="macro-nonterminal">$val</span>)) |
| }; |
| } |
| |
| <span class="doccomment">/// A macro to implement marker traits for various simd types. |
| /// #[allow(unused)] because the impls are only compiled on relevant platforms |
| /// with relevant cargo features enabled. |
| </span><span class="attribute">#[allow(unused)] |
| </span><span class="macro">macro_rules! </span>impl_unsafe_marker_for_simd { |
| (<span class="kw">unsafe impl </span><span class="macro-nonterminal">$</span><span class="kw">trait</span>:<span class="macro-nonterminal">ident </span><span class="kw">for </span><span class="macro-nonterminal">$platform</span>:ident :: {}) => {}; |
| (<span class="kw">unsafe impl </span><span class="macro-nonterminal">$</span><span class="kw">trait</span>:<span class="macro-nonterminal">ident </span><span class="kw">for </span><span class="macro-nonterminal">$platform</span>:ident :: { <span class="macro-nonterminal">$first_type</span>:ident $(, <span class="macro-nonterminal">$types</span>:ident)* $(,)<span class="question-mark">? </span>}) => { |
| <span class="kw">unsafe impl </span><span class="macro-nonterminal">$</span><span class="kw">trait for </span><span class="macro-nonterminal">$platform</span>::<span class="macro-nonterminal">$first_type </span>{} |
| <span class="macro">impl_unsafe_marker_for_simd!</span>(<span class="kw">unsafe impl </span><span class="macro-nonterminal">$</span><span class="kw">trait for </span><span class="macro-nonterminal">$platform</span>::{ $( <span class="macro-nonterminal">$types </span>),* }); |
| }; |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"extern_crate_std"</span>)] |
| </span><span class="kw">extern crate </span>std; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"extern_crate_alloc"</span>)] |
| </span><span class="kw">extern crate </span>alloc; |
| <span class="attribute">#[cfg(feature = <span class="string">"extern_crate_alloc"</span>)] |
| </span><span class="kw">pub mod </span>allocation; |
| <span class="attribute">#[cfg(feature = <span class="string">"extern_crate_alloc"</span>)] |
| </span><span class="kw">pub use </span>allocation::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>anybitpattern; |
| <span class="kw">pub use </span>anybitpattern::<span class="kw-2">*</span>; |
| |
| <span class="kw">pub mod </span>checked; |
| <span class="kw">pub use </span>checked::CheckedBitPattern; |
| |
| <span class="kw">mod </span>internal; |
| |
| <span class="kw">mod </span>zeroable; |
| <span class="kw">pub use </span>zeroable::<span class="kw-2">*</span>; |
| <span class="kw">mod </span>zeroable_in_option; |
| <span class="kw">pub use </span>zeroable_in_option::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>pod; |
| <span class="kw">pub use </span>pod::<span class="kw-2">*</span>; |
| <span class="kw">mod </span>pod_in_option; |
| <span class="kw">pub use </span>pod_in_option::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>no_uninit; |
| <span class="kw">pub use </span>no_uninit::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>contiguous; |
| <span class="kw">pub use </span>contiguous::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>offset_of; |
| <span class="kw">pub use </span>offset_of::<span class="kw-2">*</span>; |
| |
| <span class="kw">mod </span>transparent; |
| <span class="kw">pub use </span>transparent::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"derive"</span>)] |
| </span><span class="kw">pub use </span>bytemuck_derive::{ |
| AnyBitPattern, ByteEq, ByteHash, CheckedBitPattern, Contiguous, NoUninit, |
| Pod, TransparentWrapper, Zeroable, |
| }; |
| |
| <span class="doccomment">/// The things that can go wrong when casting between [`Pod`] data forms. |
| </span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] |
| </span><span class="kw">pub enum </span>PodCastError { |
| <span class="doccomment">/// You tried to cast a slice to an element type with a higher alignment |
| /// requirement but the slice wasn't aligned. |
| </span>TargetAlignmentGreaterAndInputNotAligned, |
| <span class="doccomment">/// If the element size changes then the output slice changes length |
| /// accordingly. If the output slice wouldn't be a whole number of elements |
| /// then the conversion fails. |
| </span>OutputSliceWouldHaveSlop, |
| <span class="doccomment">/// When casting a slice you can't convert between ZST elements and non-ZST |
| /// elements. When casting an individual `T`, `&T`, or `&mut T` value the |
| /// source size and destination size must be an exact match. |
| </span>SizeMismatch, |
| <span class="doccomment">/// For this type of cast the alignments must be exactly the same and they |
| /// were not so now you're sad. |
| /// |
| /// This error is generated **only** by operations that cast allocated types |
| /// (such as `Box` and `Vec`), because in that case the alignment must stay |
| /// exact. |
| </span>AlignmentMismatch, |
| } |
| <span class="attribute">#[cfg(not(target_arch = <span class="string">"spirv"</span>))] |
| </span><span class="kw">impl </span>core::fmt::Display <span class="kw">for </span>PodCastError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> core::fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"{:?}"</span>, <span class="self">self</span>) |
| } |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"extern_crate_std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>PodCastError {} |
| |
| <span class="doccomment">/// Re-interprets `&T` as `&[u8]`. |
| /// |
| /// Any ZST becomes an empty slice, and in that case the pointer value of that |
| /// empty slice might not match the pointer value of the input reference. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>bytes_of<T: NoUninit>(t: <span class="kw-2">&</span>T) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw">unsafe </span>{ internal::bytes_of(t) } |
| } |
| |
| <span class="doccomment">/// Re-interprets `&mut T` as `&mut [u8]`. |
| /// |
| /// Any ZST becomes an empty slice, and in that case the pointer value of that |
| /// empty slice might not match the pointer value of the input reference. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>bytes_of_mut<T: NoUninit + AnyBitPattern>(t: <span class="kw-2">&mut </span>T) -> <span class="kw-2">&mut </span>[u8] { |
| <span class="kw">unsafe </span>{ internal::bytes_of_mut(t) } |
| } |
| |
| <span class="doccomment">/// Re-interprets `&[u8]` as `&T`. |
| /// |
| /// ## Panics |
| /// |
| /// This is [`try_from_bytes`] but will panic on error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>from_bytes<T: AnyBitPattern>(s: <span class="kw-2">&</span>[u8]) -> <span class="kw-2">&</span>T { |
| <span class="kw">unsafe </span>{ internal::from_bytes(s) } |
| } |
| |
| <span class="doccomment">/// Re-interprets `&mut [u8]` as `&mut T`. |
| /// |
| /// ## Panics |
| /// |
| /// This is [`try_from_bytes_mut`] but will panic on error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>from_bytes_mut<T: NoUninit + AnyBitPattern>(s: <span class="kw-2">&mut </span>[u8]) -> <span class="kw-2">&mut </span>T { |
| <span class="kw">unsafe </span>{ internal::from_bytes_mut(s) } |
| } |
| |
| <span class="doccomment">/// Reads from the bytes as if they were a `T`. |
| /// |
| /// ## Failure |
| /// * If the `bytes` length is not equal to `size_of::<T>()`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_pod_read_unaligned<T: AnyBitPattern>( |
| bytes: <span class="kw-2">&</span>[u8], |
| ) -> <span class="prelude-ty">Result</span><T, PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_pod_read_unaligned(bytes) } |
| } |
| |
| <span class="doccomment">/// Reads the slice into a `T` value. |
| /// |
| /// ## Panics |
| /// * This is like `try_pod_read_unaligned` but will panic on failure. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>pod_read_unaligned<T: AnyBitPattern>(bytes: <span class="kw-2">&</span>[u8]) -> T { |
| <span class="kw">unsafe </span>{ internal::pod_read_unaligned(bytes) } |
| } |
| |
| <span class="doccomment">/// Re-interprets `&[u8]` as `&T`. |
| /// |
| /// ## Failure |
| /// |
| /// * If the slice isn't aligned for the new type |
| /// * If the slice's length isn’t exactly the size of the new type |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_from_bytes<T: AnyBitPattern>(s: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span>T, PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_from_bytes(s) } |
| } |
| |
| <span class="doccomment">/// Re-interprets `&mut [u8]` as `&mut T`. |
| /// |
| /// ## Failure |
| /// |
| /// * If the slice isn't aligned for the new type |
| /// * If the slice's length isn’t exactly the size of the new type |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_from_bytes_mut<T: NoUninit + AnyBitPattern>( |
| s: <span class="kw-2">&mut </span>[u8], |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&mut </span>T, PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_from_bytes_mut(s) } |
| } |
| |
| <span class="doccomment">/// Cast `T` into `U` |
| /// |
| /// ## Panics |
| /// |
| /// * This is like [`try_cast`](try_cast), but will panic on a size mismatch. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>cast<A: NoUninit, B: AnyBitPattern>(a: A) -> B { |
| <span class="kw">unsafe </span>{ internal::cast(a) } |
| } |
| |
| <span class="doccomment">/// Cast `&mut T` into `&mut U`. |
| /// |
| /// ## Panics |
| /// |
| /// This is [`try_cast_mut`] but will panic on error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>cast_mut<A: NoUninit + AnyBitPattern, B: NoUninit + AnyBitPattern>( |
| a: <span class="kw-2">&mut </span>A, |
| ) -> <span class="kw-2">&mut </span>B { |
| <span class="kw">unsafe </span>{ internal::cast_mut(a) } |
| } |
| |
| <span class="doccomment">/// Cast `&T` into `&U`. |
| /// |
| /// ## Panics |
| /// |
| /// This is [`try_cast_ref`] but will panic on error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>cast_ref<A: NoUninit, B: AnyBitPattern>(a: <span class="kw-2">&</span>A) -> <span class="kw-2">&</span>B { |
| <span class="kw">unsafe </span>{ internal::cast_ref(a) } |
| } |
| |
| <span class="doccomment">/// Cast `&[A]` into `&[B]`. |
| /// |
| /// ## Panics |
| /// |
| /// This is [`try_cast_slice`] but will panic on error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>cast_slice<A: NoUninit, B: AnyBitPattern>(a: <span class="kw-2">&</span>[A]) -> <span class="kw-2">&</span>[B] { |
| <span class="kw">unsafe </span>{ internal::cast_slice(a) } |
| } |
| |
| <span class="doccomment">/// Cast `&mut [T]` into `&mut [U]`. |
| /// |
| /// ## Panics |
| /// |
| /// This is [`try_cast_slice_mut`] but will panic on error. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>cast_slice_mut< |
| A: NoUninit + AnyBitPattern, |
| B: NoUninit + AnyBitPattern, |
| >( |
| a: <span class="kw-2">&mut </span>[A], |
| ) -> <span class="kw-2">&mut </span>[B] { |
| <span class="kw">unsafe </span>{ internal::cast_slice_mut(a) } |
| } |
| |
| <span class="doccomment">/// As `align_to`, but safe because of the [`Pod`] bound. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>pod_align_to<T: NoUninit, U: AnyBitPattern>( |
| vals: <span class="kw-2">&</span>[T], |
| ) -> (<span class="kw-2">&</span>[T], <span class="kw-2">&</span>[U], <span class="kw-2">&</span>[T]) { |
| <span class="kw">unsafe </span>{ vals.align_to::<U>() } |
| } |
| |
| <span class="doccomment">/// As `align_to_mut`, but safe because of the [`Pod`] bound. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>pod_align_to_mut< |
| T: NoUninit + AnyBitPattern, |
| U: NoUninit + AnyBitPattern, |
| >( |
| vals: <span class="kw-2">&mut </span>[T], |
| ) -> (<span class="kw-2">&mut </span>[T], <span class="kw-2">&mut </span>[U], <span class="kw-2">&mut </span>[T]) { |
| <span class="kw">unsafe </span>{ vals.align_to_mut::<U>() } |
| } |
| |
| <span class="doccomment">/// Try to cast `T` into `U`. |
| /// |
| /// Note that for this particular type of cast, alignment isn't a factor. The |
| /// input value is semantically copied into the function and then returned to a |
| /// new memory location which will have whatever the required alignment of the |
| /// output type is. |
| /// |
| /// ## Failure |
| /// |
| /// * If the types don't have the same size this fails. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_cast<A: NoUninit, B: AnyBitPattern>( |
| a: A, |
| ) -> <span class="prelude-ty">Result</span><B, PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_cast(a) } |
| } |
| |
| <span class="doccomment">/// Try to convert a `&T` into `&U`. |
| /// |
| /// ## Failure |
| /// |
| /// * If the reference isn't aligned in the new type |
| /// * If the source type and target type aren't the same size. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_cast_ref<A: NoUninit, B: AnyBitPattern>( |
| a: <span class="kw-2">&</span>A, |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span>B, PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_cast_ref(a) } |
| } |
| |
| <span class="doccomment">/// Try to convert a `&mut T` into `&mut U`. |
| /// |
| /// As [`try_cast_ref`], but `mut`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_cast_mut< |
| A: NoUninit + AnyBitPattern, |
| B: NoUninit + AnyBitPattern, |
| >( |
| a: <span class="kw-2">&mut </span>A, |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&mut </span>B, PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_cast_mut(a) } |
| } |
| |
| <span class="doccomment">/// Try to convert `&[A]` into `&[B]` (possibly with a change in length). |
| /// |
| /// * `input.as_ptr() as usize == output.as_ptr() as usize` |
| /// * `input.len() * size_of::<A>() == output.len() * size_of::<B>()` |
| /// |
| /// ## Failure |
| /// |
| /// * If the target type has a greater alignment requirement and the input slice |
| /// isn't aligned. |
| /// * If the target element type is a different size from the current element |
| /// type, and the output slice wouldn't be a whole number of elements when |
| /// accounting for the size change (eg: 3 `u16` values is 1.5 `u32` values, so |
| /// that's a failure). |
| /// * Similarly, you can't convert between a [ZST](https://doc.rust-lang.org/nomicon/exotic-sizes.html#zero-sized-types-zsts) |
| /// and a non-ZST. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_cast_slice<A: NoUninit, B: AnyBitPattern>( |
| a: <span class="kw-2">&</span>[A], |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span>[B], PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_cast_slice(a) } |
| } |
| |
| <span class="doccomment">/// Try to convert `&mut [A]` into `&mut [B]` (possibly with a change in |
| /// length). |
| /// |
| /// As [`try_cast_slice`], but `&mut`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>try_cast_slice_mut< |
| A: NoUninit + AnyBitPattern, |
| B: NoUninit + AnyBitPattern, |
| >( |
| a: <span class="kw-2">&mut </span>[A], |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&mut </span>[B], PodCastError> { |
| <span class="kw">unsafe </span>{ internal::try_cast_slice_mut(a) } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="bytemuck" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
