18 lines
8.8 KiB
HTML
18 lines
8.8 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="A `ByteSlice` that conveys no ownership, and so can be converted into a byte slice."><title>IntoByteSlice in zerocopy::byte_slice - 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="zerocopy" 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="#">IntoByteSlice</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../zerocopy/index.html">zerocopy</a><span class="version">0.8.39</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Into<wbr>Byte<wbr>Slice</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_byte_slice" title="into_byte_slice">into_byte_slice</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IntoByteSlice%3C'a%3E-for-%26%5Bu8%5D" title="&'a [u8]">&'a [u8]</a></li><li><a href="#impl-IntoByteSlice%3C'a%3E-for-%26mut+%5Bu8%5D" title="&'a mut [u8]">&'a mut [u8]</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 zerocopy::<wbr>byte_<wbr>slice</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">zerocopy</a>::<wbr><a href="index.html">byte_slice</a></div><h1>Trait <span class="trait">Into<wbr>Byte<wbr>Slice</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/zerocopy/byte_slice.rs.html#157-169">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait IntoByteSlice<'a>: <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a> {
|
||
// Required method
|
||
fn <a href="#tymethod.into_byte_slice" class="fn">into_byte_slice</a>(self) -> &'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>];
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A <a href="trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice"><code>ByteSlice</code></a> that conveys no ownership, and so can be converted into a
|
||
byte slice.</p>
|
||
<p>Some <code>ByteSlice</code> types (notably, the standard library’s <a href="https://doc.rust-lang.org/1.93.1/core/cell/struct.Ref.html" title="struct core::cell::Ref"><code>Ref</code></a> type) convey
|
||
ownership, and so they cannot soundly be moved by-value into a byte slice
|
||
type (<code>&[u8]</code>). Some methods in this crate’s API (such as <a href="../struct.Ref.html#method.into_ref" title="associated function zerocopy::Ref::into_ref"><code>Ref::into_ref</code></a>)
|
||
are only compatible with <code>ByteSlice</code> types without these ownership
|
||
semantics.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.into_byte_slice" class="method"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#168">Source</a><h4 class="code-header">fn <a href="#tymethod.into_byte_slice" class="fn">into_byte_slice</a>(self) -> &'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h4></section></summary><div class="docblock"><p>Coverts <code>self</code> into a <code>&[u8]</code>.</p>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p>The returned reference has the same address and length as <code>self.deref()</code>
|
||
and <code>self.deref_mut()</code>.</p>
|
||
<p>Note that, combined with the safety invariant on <a href="trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice"><code>ByteSlice</code></a>, this
|
||
safety invariant implies that the returned reference is “stable” in the
|
||
sense described in the <code>ByteSlice</code> docs.</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="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IntoByteSlice%3C'a%3E-for-%26%5Bu8%5D" class="impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#223-232">Source</a><a href="#impl-IntoByteSlice%3C'a%3E-for-%26%5Bu8%5D" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.IntoByteSlice.html" title="trait zerocopy::byte_slice::IntoByteSlice">IntoByteSlice</a><'a> for &'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h3></section></summary><div class="impl-items"><section id="method.into_byte_slice" class="method trait-impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#225-231">Source</a><a href="#method.into_byte_slice" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_byte_slice" class="fn">into_byte_slice</a>(self) -> &'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoByteSlice%3C'a%3E-for-%26mut+%5Bu8%5D" class="impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#299-308">Source</a><a href="#impl-IntoByteSlice%3C'a%3E-for-%26mut+%5Bu8%5D" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.IntoByteSlice.html" title="trait zerocopy::byte_slice::IntoByteSlice">IntoByteSlice</a><'a> for &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h3></section></summary><div class="impl-items"><section id="method.into_byte_slice-1" class="method trait-impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#301-307">Source</a><a href="#method.into_byte_slice-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_byte_slice" class="fn">into_byte_slice</a>(self) -> &'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/zerocopy/byte_slice/trait.IntoByteSlice.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |