| <!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/pod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>pod.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> |
| </pre><pre class="rust"><code><span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="doccomment">/// Marker trait for "plain old data". |
| /// |
| /// The point of this trait is that once something is marked "plain old data" |
| /// you can really go to town with the bit fiddling and bit casting. Therefore, |
| /// it's a relatively strong claim to make about a type. Do not add this to your |
| /// type casually. |
| /// |
| /// **Reminder:** The results of casting around bytes between data types are |
| /// _endian dependant_. Little-endian machines are the most common, but |
| /// big-endian machines do exist (and big-endian is also used for "network |
| /// order" bytes). |
| /// |
| /// ## Safety |
| /// |
| /// * The type must be inhabited (eg: no |
| /// [Infallible](core::convert::Infallible)). |
| /// * The type must allow any bit pattern (eg: no `bool` or `char`, which have |
| /// illegal bit patterns). |
| /// * The type must not contain any uninit (or padding) bytes, either in the |
| /// middle or on the end (eg: no `#[repr(C)] struct Foo(u8, u16)`, which has |
| /// padding in the middle, and also no `#[repr(C)] struct Foo(u16, u8)`, which |
| /// has padding on the end). |
| /// * The type needs to have all fields also be `Pod`. |
| /// * The type needs to be `repr(C)` or `repr(transparent)`. In the case of |
| /// `repr(C)`, the `packed` and `align` repr modifiers can be used as long as |
| /// all other rules end up being followed. |
| /// * It is disallowed for types to contain pointer types, `Cell`, `UnsafeCell`, |
| /// atomics, and any other forms of interior mutability. |
| /// * More precisely: A shared reference to the type must allow reads, and |
| /// *only* reads. RustBelt's separation logic is based on the notion that a |
| /// type is allowed to define a sharing predicate, its own invariant that must |
| /// hold for shared references, and this predicate is the reasoning that allow |
| /// it to deal with atomic and cells etc. We require the sharing predicate to |
| /// be trivial and permit only read-only access. |
| </span><span class="kw">pub unsafe trait </span>Pod: Zeroable + Copy + <span class="lifetime">'static </span>{} |
| |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>() {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>u8 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>i8 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>u16 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>i16 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>u32 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>i32 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>u64 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>i64 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>usize {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>isize {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>u128 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>i128 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>f32 {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>f64 {} |
| <span class="kw">unsafe impl</span><T: Pod> Pod <span class="kw">for </span>Wrapping<T> {} |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"unsound_ptr_pod_impl"</span>)] |
| </span><span class="kw">unsafe impl</span><T: <span class="lifetime">'static</span>> Pod <span class="kw">for </span><span class="kw-2">*mut </span>T {} |
| <span class="attribute">#[cfg(feature = <span class="string">"unsound_ptr_pod_impl"</span>)] |
| </span><span class="kw">unsafe impl</span><T: <span class="lifetime">'static</span>> Pod <span class="kw">for </span><span class="kw-2">*const </span>T {} |
| <span class="attribute">#[cfg(feature = <span class="string">"unsound_ptr_pod_impl"</span>)] |
| </span><span class="kw">unsafe impl</span><T: <span class="lifetime">'static</span>> PodInOption <span class="kw">for </span>NonNull<T> {} |
| |
| <span class="kw">unsafe impl</span><T: Pod> Pod <span class="kw">for </span>PhantomData<T> {} |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>PhantomPinned {} |
| <span class="kw">unsafe impl</span><T: Pod> Pod <span class="kw">for </span>ManuallyDrop<T> {} |
| |
| <span class="comment">// Note(Lokathor): MaybeUninit can NEVER be Pod. |
| |
| </span><span class="attribute">#[cfg(feature = <span class="string">"min_const_generics"</span>)] |
| </span><span class="kw">unsafe impl</span><T, <span class="kw">const </span>N: usize> Pod <span class="kw">for </span>[T; N] <span class="kw">where </span>T: Pod {} |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"min_const_generics"</span>))] |
| </span><span class="macro">impl_unsafe_marker_for_array!</span>( |
| Pod, <span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">10</span>, <span class="number">11</span>, <span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>, <span class="number">15</span>, <span class="number">16</span>, <span class="number">17</span>, <span class="number">18</span>, <span class="number">19</span>, |
| <span class="number">20</span>, <span class="number">21</span>, <span class="number">22</span>, <span class="number">23</span>, <span class="number">24</span>, <span class="number">25</span>, <span class="number">26</span>, <span class="number">27</span>, <span class="number">28</span>, <span class="number">29</span>, <span class="number">30</span>, <span class="number">31</span>, <span class="number">32</span>, <span class="number">48</span>, <span class="number">64</span>, <span class="number">96</span>, <span class="number">128</span>, <span class="number">256</span>, |
| <span class="number">512</span>, <span class="number">1024</span>, <span class="number">2048</span>, <span class="number">4096 |
| </span>); |
| |
| <span class="attribute">#[cfg(all(target_arch = <span class="string">"wasm32"</span>, feature = <span class="string">"wasm_simd"</span>))] |
| </span><span class="macro">impl_unsafe_marker_for_simd!</span>( |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>wasm32::{v128} |
| ); |
| |
| <span class="attribute">#[cfg(all(target_arch = <span class="string">"aarch64"</span>, feature = <span class="string">"aarch64_simd"</span>))] |
| </span><span class="macro">impl_unsafe_marker_for_simd!</span>( |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>aarch64::{ |
| float32x2_t, float32x2x2_t, float32x2x3_t, float32x2x4_t, float32x4_t, |
| float32x4x2_t, float32x4x3_t, float32x4x4_t, float64x1_t, float64x1x2_t, |
| float64x1x3_t, float64x1x4_t, float64x2_t, float64x2x2_t, float64x2x3_t, |
| float64x2x4_t, int16x4_t, int16x4x2_t, int16x4x3_t, int16x4x4_t, int16x8_t, |
| int16x8x2_t, int16x8x3_t, int16x8x4_t, int32x2_t, int32x2x2_t, int32x2x3_t, |
| int32x2x4_t, int32x4_t, int32x4x2_t, int32x4x3_t, int32x4x4_t, int64x1_t, |
| int64x1x2_t, int64x1x3_t, int64x1x4_t, int64x2_t, int64x2x2_t, int64x2x3_t, |
| int64x2x4_t, int8x16_t, int8x16x2_t, int8x16x3_t, int8x16x4_t, int8x8_t, |
| int8x8x2_t, int8x8x3_t, int8x8x4_t, poly16x4_t, poly16x4x2_t, poly16x4x3_t, |
| poly16x4x4_t, poly16x8_t, poly16x8x2_t, poly16x8x3_t, poly16x8x4_t, |
| poly64x1_t, poly64x1x2_t, poly64x1x3_t, poly64x1x4_t, poly64x2_t, |
| poly64x2x2_t, poly64x2x3_t, poly64x2x4_t, poly8x16_t, poly8x16x2_t, |
| poly8x16x3_t, poly8x16x4_t, poly8x8_t, poly8x8x2_t, poly8x8x3_t, poly8x8x4_t, |
| uint16x4_t, uint16x4x2_t, uint16x4x3_t, uint16x4x4_t, uint16x8_t, |
| uint16x8x2_t, uint16x8x3_t, uint16x8x4_t, uint32x2_t, uint32x2x2_t, |
| uint32x2x3_t, uint32x2x4_t, uint32x4_t, uint32x4x2_t, uint32x4x3_t, |
| uint32x4x4_t, uint64x1_t, uint64x1x2_t, uint64x1x3_t, uint64x1x4_t, |
| uint64x2_t, uint64x2x2_t, uint64x2x3_t, uint64x2x4_t, uint8x16_t, |
| uint8x16x2_t, uint8x16x3_t, uint8x16x4_t, uint8x8_t, uint8x8x2_t, |
| uint8x8x3_t, uint8x8x4_t, |
| } |
| ); |
| |
| <span class="attribute">#[cfg(target_arch = <span class="string">"x86"</span>)] |
| </span><span class="macro">impl_unsafe_marker_for_simd!</span>( |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>x86::{ |
| __m128i, __m128, __m128d, |
| __m256i, __m256, __m256d, |
| } |
| ); |
| |
| <span class="attribute">#[cfg(target_arch = <span class="string">"x86_64"</span>)] |
| </span><span class="macro">impl_unsafe_marker_for_simd!</span>( |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>x86_64::{ |
| __m128i, __m128, __m128d, |
| __m256i, __m256, __m256d, |
| } |
| ); |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"nightly_portable_simd"</span>)] |
| </span><span class="kw">unsafe impl</span><T, <span class="kw">const </span>N: usize> Pod <span class="kw">for </span>core::simd::Simd<T, N> |
| <span class="kw">where |
| </span>T: core::simd::SimdElement + Pod, |
| core::simd::LaneCount<N>: core::simd::SupportedLaneCount, |
| { |
| } |
| |
| <span class="attribute">#[cfg(all(target_arch = <span class="string">"x86"</span>, feature = <span class="string">"nightly_stdsimd"</span>))] |
| </span><span class="macro">impl_unsafe_marker_for_simd!</span>( |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>x86::{ |
| __m128bh, __m256bh, __m512, |
| __m512bh, __m512d, __m512i, |
| } |
| ); |
| |
| <span class="attribute">#[cfg(all(target_arch = <span class="string">"x86_64"</span>, feature = <span class="string">"nightly_stdsimd"</span>))] |
| </span><span class="macro">impl_unsafe_marker_for_simd!</span>( |
| <span class="kw">unsafe impl </span>Pod <span class="kw">for </span>x86_64::{ |
| __m128bh, __m256bh, __m512, |
| __m512bh, __m512d, __m512i, |
| } |
| ); |
| </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> |
