Files
phy/bytemuck/trait.ZeroableInOption.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

8 lines
15 KiB
HTML

<!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 Zeroable when wrapped in Option."><title>ZeroableInOption in bytemuck - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bytemuck" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bytemuck/index.html">bytemuck</a><span class="version">1.21.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Zeroable<wbr>InOption</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ZeroableInOption-for-%26T" title="&#38;T">&#38;T</a></li><li><a href="#impl-ZeroableInOption-for-%26mut+T" title="&#38;mut T">&#38;mut T</a></li><li><a href="#impl-ZeroableInOption-for-Box%3CT%3E" title="Box&#60;T&#62;">Box&#60;T&#62;</a></li><li><a href="#impl-ZeroableInOption-for-NonNull%3CT%3E" title="NonNull&#60;T&#62;">NonNull&#60;T&#62;</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Ci128%3E" title="NonZeroI128">NonZeroI128</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Ci16%3E" title="NonZeroI16">NonZeroI16</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Ci32%3E" title="NonZeroI32">NonZeroI32</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Ci64%3E" title="NonZeroI64">NonZeroI64</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Ci8%3E" title="NonZeroI8">NonZeroI8</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Cisize%3E" title="NonZeroIsize">NonZeroIsize</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Cu128%3E" title="NonZeroU128">NonZeroU128</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Cu16%3E" title="NonZeroU16">NonZeroU16</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Cu32%3E" title="NonZeroU32">NonZeroU32</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Cu64%3E" title="NonZeroU64">NonZeroU64</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Cu8%3E" title="NonZeroU8">NonZeroU8</a></li><li><a href="#impl-ZeroableInOption-for-NonZero%3Cusize%3E" title="NonZeroUsize">NonZeroUsize</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bytemuck</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bytemuck</a></span><h1>Trait <span class="trait">ZeroableInOption</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bytemuck/zeroable_in_option.rs.html#13">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait ZeroableInOption: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> { }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for types which are <a href="trait.Zeroable.html" title="trait bytemuck::Zeroable">Zeroable</a> when wrapped in
<a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>.</p>
<h3 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h3>
<ul>
<li><code>Option&lt;YourType&gt;</code> must uphold the same invariants as
<a href="trait.Zeroable.html" title="trait bytemuck::Zeroable">Zeroable</a>.</li>
</ul>
</div></details><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-ZeroableInOption-for-NonZero%3Ci8%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#15">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Ci8%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroI8.html" title="type core::num::nonzero::NonZeroI8">NonZeroI8</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Ci16%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#16">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Ci16%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroI16.html" title="type core::num::nonzero::NonZeroI16">NonZeroI16</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Ci32%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#17">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Ci32%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroI32.html" title="type core::num::nonzero::NonZeroI32">NonZeroI32</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Ci64%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#18">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Ci64%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroI64.html" title="type core::num::nonzero::NonZeroI64">NonZeroI64</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Ci128%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#19">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Ci128%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroI128.html" title="type core::num::nonzero::NonZeroI128">NonZeroI128</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Cisize%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#20">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Cisize%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroIsize.html" title="type core::num::nonzero::NonZeroIsize">NonZeroIsize</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Cu8%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#21">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Cu8%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroU8.html" title="type core::num::nonzero::NonZeroU8">NonZeroU8</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Cu16%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#22">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Cu16%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroU16.html" title="type core::num::nonzero::NonZeroU16">NonZeroU16</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Cu32%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#23">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Cu32%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroU32.html" title="type core::num::nonzero::NonZeroU32">NonZeroU32</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Cu64%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#24">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Cu64%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroU64.html" title="type core::num::nonzero::NonZeroU64">NonZeroU64</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Cu128%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#25">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Cu128%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroU128.html" title="type core::num::nonzero::NonZeroU128">NonZeroU128</a></h3></section><section id="impl-ZeroableInOption-for-NonZero%3Cusize%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#26">Source</a><a href="#impl-ZeroableInOption-for-NonZero%3Cusize%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="type" href="https://doc.rust-lang.org/1.84.0/core/num/nonzero/type.NonZeroUsize.html" title="type core::num::nonzero::NonZeroUsize">NonZeroUsize</a></h3></section><section id="impl-ZeroableInOption-for-%26T" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#30">Source</a><a href="#impl-ZeroableInOption-for-%26T" class="anchor">§</a><h3 class="code-header">impl&lt;T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&amp;T</a></h3></section><section id="impl-ZeroableInOption-for-%26mut+T" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#31">Source</a><a href="#impl-ZeroableInOption-for-%26mut+T" class="anchor">§</a><h3 class="code-header">impl&lt;T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&amp;mut T</a></h3></section><section id="impl-ZeroableInOption-for-Box%3CT%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#35">Source</a><a href="#impl-ZeroableInOption-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;T&gt;</h3></section><section id="impl-ZeroableInOption-for-NonNull%3CT%3E" class="impl"><a class="src rightside" href="../src/bytemuck/zeroable_in_option.rs.html#29">Source</a><a href="#impl-ZeroableInOption-for-NonNull%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.ZeroableInOption.html" title="trait bytemuck::ZeroableInOption">ZeroableInOption</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/ptr/non_null/struct.NonNull.html" title="struct core::ptr::non_null::NonNull">NonNull</a>&lt;T&gt;</h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/bytemuck/zeroable_in_option/trait.ZeroableInOption.js" data-ignore-extern-crates="core,alloc" async></script></section></div></main></body></html>