Files
GopherGate/target/doc/bytemuck/allocation/trait.TransparentWrapperAlloc.html
2026-02-26 12:00:21 -05:00

30 lines
16 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="An extension trait for `TransparentWrapper` and alloc types."><title>TransparentWrapperAlloc in bytemuck::allocation - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">TransparentWrapperAlloc</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bytemuck/index.html">bytemuck</a><span class="version">1.25.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Transparent<wbr>Wrapper<wbr>Alloc</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.peel_arc" title="peel_arc">peel_arc</a></li><li><a href="#method.peel_box" title="peel_box">peel_box</a></li><li><a href="#method.peel_rc" title="peel_rc">peel_rc</a></li><li><a href="#method.peel_vec" title="peel_vec">peel_vec</a></li><li><a href="#method.wrap_arc" title="wrap_arc">wrap_arc</a></li><li><a href="#method.wrap_box" title="wrap_box">wrap_box</a></li><li><a href="#method.wrap_rc" title="wrap_rc">wrap_rc</a></li><li><a href="#method.wrap_vec" title="wrap_vec">wrap_vec</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><a href="index.html">In bytemuck::<wbr>allocation</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">bytemuck</a>::<wbr><a href="index.html">allocation</a></div><h1>Trait <span class="trait">Transparent<wbr>Wrapper<wbr>Alloc</span>&nbsp;<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/allocation.rs.html#562-770">Source</a> </span></div><pre class="rust item-decl"><code>pub trait TransparentWrapperAlloc&lt;Inner: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt;: <a class="trait" href="../trait.TransparentWrapper.html" title="trait bytemuck::TransparentWrapper">TransparentWrapper</a>&lt;Inner&gt; {
// Provided methods
fn <a href="#method.wrap_vec" class="fn">wrap_vec</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Self&gt;
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
Inner: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
<span class="item-spacer"></span> fn <a href="#method.wrap_box" class="fn">wrap_box</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.wrap_rc" class="fn">wrap_rc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.wrap_arc" class="fn">wrap_arc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Self&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.peel_vec" class="fn">peel_vec</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Inner&gt;
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
Inner: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
<span class="item-spacer"></span> fn <a href="#method.peel_box" class="fn">peel_box</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Inner&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.peel_rc" class="fn">peel_rc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Inner&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.peel_arc" class="fn">peel_arc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Inner&gt; { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An extension trait for <code>TransparentWrapper</code> and alloc types.</p>
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.wrap_vec" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#566-584">Source</a><h4 class="code-header">fn <a href="#method.wrap_vec" class="fn">wrap_vec</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Self&gt;<div class="where">where
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
Inner: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Convert a vec of the inner type into a vec of the wrapper type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.wrap_box" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#589-613">Source</a><h4 class="code-header">fn <a href="#method.wrap_box" class="fn">wrap_box</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Convert a box to the inner type into a box to the wrapper
type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.wrap_rc" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#617-639">Source</a><h4 class="code-header">fn <a href="#method.wrap_rc" class="fn">wrap_rc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Convert an <a href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc"><code>Rc</code></a> to the inner type into an <code>Rc</code> to the wrapper type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.wrap_arc" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#644-666">Source</a><h4 class="code-header">fn <a href="#method.wrap_arc" class="fn">wrap_arc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Inner&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Convert an <a href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc"><code>Arc</code></a> to the inner type into an <code>Arc</code> to the wrapper type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.peel_vec" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#669-687">Source</a><h4 class="code-header">fn <a href="#method.peel_vec" class="fn">peel_vec</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;Inner&gt;<div class="where">where
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
Inner: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Convert a vec of the wrapper type into a vec of the inner type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.peel_box" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#692-716">Source</a><h4 class="code-header">fn <a href="#method.peel_box" class="fn">peel_box</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Inner&gt;</h4></section></summary><div class="docblock"><p>Convert a box to the wrapper type into a box to the inner
type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.peel_rc" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#720-742">Source</a><h4 class="code-header">fn <a href="#method.peel_rc" class="fn">peel_rc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Inner&gt;</h4></section></summary><div class="docblock"><p>Convert an <a href="https://doc.rust-lang.org/1.93.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc"><code>Rc</code></a> to the wrapper type into an <code>Rc</code> to the inner type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.peel_arc" class="method"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#747-769">Source</a><h4 class="code-header">fn <a href="#method.peel_arc" class="fn">peel_arc</a>(s: <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Self&gt;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Inner&gt;</h4></section></summary><div class="docblock"><p>Convert an <a href="https://doc.rust-lang.org/1.93.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc"><code>Arc</code></a> to the wrapper type into an <code>Arc</code> to the inner type.</p>
</div></details></div><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.93.1/reference/items/traits.html#dyn-compatibility">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="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-TransparentWrapperAlloc%3CI%3E-for-T" class="impl"><a class="src rightside" href="../../src/bytemuck/allocation.rs.html#772-775">Source</a><a href="#impl-TransparentWrapperAlloc%3CI%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;I: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../trait.TransparentWrapper.html" title="trait bytemuck::TransparentWrapper">TransparentWrapper</a>&lt;I&gt;&gt; <a class="trait" href="trait.TransparentWrapperAlloc.html" title="trait bytemuck::allocation::TransparentWrapperAlloc">TransparentWrapperAlloc</a>&lt;I&gt; for T</h3></section></div><script src="../../trait.impl/bytemuck/allocation/trait.TransparentWrapperAlloc.js" async></script></section></div></main></body></html>