blob: 594ff769082c5f7f161af352545b532a3c467f4e [file] [log] [blame]
<!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="Trait for types which are Pod when wrapped in Option."><meta name="keywords" content="rust, rustlang, rust-lang, PodInOption"><title>PodInOption in bytemuck - Rust</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="sidebar-items.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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../bytemuck/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">PodInOption</a></h2><div class="sidebar-elems"><section><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-PodInOption-for-NonZeroI128">NonZeroI128</a></li><li><a href="#impl-PodInOption-for-NonZeroI16">NonZeroI16</a></li><li><a href="#impl-PodInOption-for-NonZeroI32">NonZeroI32</a></li><li><a href="#impl-PodInOption-for-NonZeroI64">NonZeroI64</a></li><li><a href="#impl-PodInOption-for-NonZeroI8">NonZeroI8</a></li><li><a href="#impl-PodInOption-for-NonZeroIsize">NonZeroIsize</a></li><li><a href="#impl-PodInOption-for-NonZeroU128">NonZeroU128</a></li><li><a href="#impl-PodInOption-for-NonZeroU16">NonZeroU16</a></li><li><a href="#impl-PodInOption-for-NonZeroU32">NonZeroU32</a></li><li><a href="#impl-PodInOption-for-NonZeroU64">NonZeroU64</a></li><li><a href="#impl-PodInOption-for-NonZeroU8">NonZeroU8</a></li><li><a href="#impl-PodInOption-for-NonZeroUsize">NonZeroUsize</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In bytemuck</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Trait <a href="index.html">bytemuck</a>::<wbr><a class="trait" href="#">PodInOption</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/bytemuck/pod_in_option.rs.html#14">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub unsafe trait PodInOption: <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + 'static { }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for types which are <a href="trait.Pod.html">Pod</a> when wrapped in
<a href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html">Option</a>.</p>
<h3 id="safety"><a href="#safety">Safety</a></h3>
<ul>
<li><code>Option&lt;T&gt;</code> must uphold the same invariants as <a href="trait.Pod.html">Pod</a>.</li>
<li><strong>Reminder:</strong> pointers are <strong>not</strong> pod! <strong>Do not</strong> mix this trait with a
newtype over <a href="https://doc.rust-lang.org/nightly/core/ptr/non_null/struct.NonNull.html">NonNull</a>.</li>
</ul>
</div></details><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><section id="impl-PodInOption-for-NonZeroI8" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#16">source</a><a href="#impl-PodInOption-for-NonZeroI8" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroI8.html" title="struct core::num::nonzero::NonZeroI8">NonZeroI8</a></h3></section><section id="impl-PodInOption-for-NonZeroI16" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#17">source</a><a href="#impl-PodInOption-for-NonZeroI16" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroI16.html" title="struct core::num::nonzero::NonZeroI16">NonZeroI16</a></h3></section><section id="impl-PodInOption-for-NonZeroI32" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#18">source</a><a href="#impl-PodInOption-for-NonZeroI32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroI32.html" title="struct core::num::nonzero::NonZeroI32">NonZeroI32</a></h3></section><section id="impl-PodInOption-for-NonZeroI64" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#19">source</a><a href="#impl-PodInOption-for-NonZeroI64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroI64.html" title="struct core::num::nonzero::NonZeroI64">NonZeroI64</a></h3></section><section id="impl-PodInOption-for-NonZeroI128" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#20">source</a><a href="#impl-PodInOption-for-NonZeroI128" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroI128.html" title="struct core::num::nonzero::NonZeroI128">NonZeroI128</a></h3></section><section id="impl-PodInOption-for-NonZeroIsize" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#21">source</a><a href="#impl-PodInOption-for-NonZeroIsize" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroIsize.html" title="struct core::num::nonzero::NonZeroIsize">NonZeroIsize</a></h3></section><section id="impl-PodInOption-for-NonZeroU8" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#22">source</a><a href="#impl-PodInOption-for-NonZeroU8" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU8.html" title="struct core::num::nonzero::NonZeroU8">NonZeroU8</a></h3></section><section id="impl-PodInOption-for-NonZeroU16" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#23">source</a><a href="#impl-PodInOption-for-NonZeroU16" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU16.html" title="struct core::num::nonzero::NonZeroU16">NonZeroU16</a></h3></section><section id="impl-PodInOption-for-NonZeroU32" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#24">source</a><a href="#impl-PodInOption-for-NonZeroU32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU32.html" title="struct core::num::nonzero::NonZeroU32">NonZeroU32</a></h3></section><section id="impl-PodInOption-for-NonZeroU64" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#25">source</a><a href="#impl-PodInOption-for-NonZeroU64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU64.html" title="struct core::num::nonzero::NonZeroU64">NonZeroU64</a></h3></section><section id="impl-PodInOption-for-NonZeroU128" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#26">source</a><a href="#impl-PodInOption-for-NonZeroU128" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroU128.html" title="struct core::num::nonzero::NonZeroU128">NonZeroU128</a></h3></section><section id="impl-PodInOption-for-NonZeroUsize" class="impl has-srclink"><a class="srclink rightside" href="../src/bytemuck/pod_in_option.rs.html#27">source</a><a href="#impl-PodInOption-for-NonZeroUsize" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.PodInOption.html" title="trait bytemuck::PodInOption">PodInOption</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/nonzero/struct.NonZeroUsize.html" title="struct core::num::nonzero::NonZeroUsize">NonZeroUsize</a></h3></section><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/bytemuck/pod_in_option/trait.PodInOption.js" data-ignore-extern-crates="core" async></script></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>