| <!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/anybitpattern.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>anybitpattern.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> |
| </pre><pre class="rust"><code><span class="kw">use crate</span>::{Pod, Zeroable}; |
| |
| <span class="doccomment">/// Marker trait for "plain old data" types that are valid for any bit pattern. |
| /// |
| /// The requirements for this is very similar to [`Pod`], |
| /// except that the type can allow uninit (or padding) bytes. |
| /// This limits what you can do with a type of this kind, but also broadens the |
| /// included types to `repr(C)` `struct`s that contain padding as well as |
| /// `union`s. Notably, you can only cast *immutable* references and *owned* |
| /// values into [`AnyBitPattern`] types, not *mutable* references. |
| /// |
| /// [`Pod`] is a subset of [`AnyBitPattern`], meaning that any `T: Pod` is also |
| /// [`AnyBitPattern`] but any `T: AnyBitPattern` is not necessarily [`Pod`]. |
| /// |
| /// [`AnyBitPattern`] is a subset of [`Zeroable`], meaning that any `T: |
| /// AnyBitPattern` is also [`Zeroable`], but any `T: Zeroable` is not |
| /// necessarily [`AnyBitPattern ] |
| /// |
| /// # Derive |
| /// |
| /// A `#[derive(AnyBitPattern)]` macro is provided under the `derive` feature |
| /// flag which will automatically validate the requirements of this trait and |
| /// implement the trait for you for both structs and enums. This is the |
| /// recommended method for implementing the trait, however it's also possible to |
| /// do manually. If you implement it manually, you *must* carefully follow the |
| /// below safety rules. |
| /// |
| /// * *NOTE: even `C-style`, fieldless enums are intentionally **excluded** from |
| /// this trait, since it is **unsound** for an enum to have a discriminant value |
| /// that is not one of its defined variants. |
| /// |
| /// # Safety |
| /// |
| /// Similar to [`Pod`] except we disregard the rule about it must not contain |
| /// uninit bytes. Still, this is a quite strong guarantee about a type, so *be |
| /// careful* when implementing it manually. |
| /// |
| /// * The type must be inhabited (eg: no |
| /// [Infallible](core::convert::Infallible)). |
| /// * The type must be valid for any bit pattern of its backing memory. |
| /// * Structs need to have all fields also be `AnyBitPattern`. |
| /// * 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. |
| /// * There's probably more, don't mess it up (I mean it). |
| </span><span class="kw">pub unsafe trait </span>AnyBitPattern: |
| Zeroable + Sized + Copy + <span class="lifetime">'static |
| </span>{ |
| } |
| |
| <span class="kw">unsafe impl</span><T: Pod> AnyBitPattern <span class="kw">for </span>T {} |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"zeroable_maybe_uninit"</span>)] |
| </span><span class="kw">unsafe impl</span><T> AnyBitPattern <span class="kw">for </span>core::mem::MaybeUninit<T> <span class="kw">where </span>T: AnyBitPattern |
| {} |
| </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> |
