18 lines
9.1 KiB
HTML
18 lines
9.1 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 mutable or immutable reference to a byte slice."><title>ByteSlice 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="#">ByteSlice</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="#">Byte<wbr>Slice</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-ByteSlice-for-%26%5Bu8%5D" title="&[u8]">&[u8]</a></li><li><a href="#impl-ByteSlice-for-%26mut+%5Bu8%5D" title="&mut [u8]">&mut [u8]</a></li><li><a href="#impl-ByteSlice-for-Ref%3C'_,+%5Bu8%5D%3E" title="Ref<'_, [u8]>">Ref<'_, [u8]></a></li><li><a href="#impl-ByteSlice-for-RefMut%3C'_,+%5Bu8%5D%3E" title="RefMut<'_, [u8]>">RefMut<'_, [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">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#50">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait ByteSlice: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/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>A mutable or immutable reference to a byte slice.</p>
|
|
<p><code>ByteSlice</code> abstracts over the mutability of a byte slice reference, and is
|
|
implemented for various special reference types such as
|
|
<a href="https://doc.rust-lang.org/1.93.1/core/cell/struct.Ref.html" title="struct core::cell::Ref"><code>Ref<[u8]></code></a> and <a href="https://doc.rust-lang.org/1.93.1/core/cell/struct.RefMut.html" title="struct core::cell::RefMut"><code>RefMut<[u8]></code></a>.</p>
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
|
<p>Implementations of <code>ByteSlice</code> must promise that their implementations of
|
|
<a href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref"><code>Deref</code></a> and <a href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut"><code>DerefMut</code></a> are “stable”. In particular, given <code>B: ByteSlice</code>
|
|
and <code>b: B</code>, two calls, each to either <code>b.deref()</code> or <code>b.deref_mut()</code>, must
|
|
return a byte slice with the same address and length. This must hold even if
|
|
the two calls are separated by an arbitrary sequence of calls to methods on
|
|
<code>ByteSlice</code>, <a href="trait.ByteSliceMut.html" title="trait zerocopy::byte_slice::ByteSliceMut"><code>ByteSliceMut</code></a>, <a href="trait.IntoByteSlice.html" title="trait zerocopy::byte_slice::IntoByteSlice"><code>IntoByteSlice</code></a>, or <a href="trait.IntoByteSliceMut.html" title="trait zerocopy::byte_slice::IntoByteSliceMut"><code>IntoByteSliceMut</code></a>,
|
|
or on their super-traits. This does <em>not</em> need to hold if the two calls are
|
|
separated by any method calls, field accesses, or field modifications <em>other
|
|
than</em> those from these traits.</p>
|
|
<p>Note that this also implies that, given <code>b: B</code>, the address and length
|
|
cannot be modified via objects other than <code>b</code>, either on the same thread or
|
|
on another thread.</p>
|
|
</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.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><section id="impl-ByteSlice-for-%26%5Bu8%5D" class="impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#198">Source</a><a href="#impl-ByteSlice-for-%26%5Bu8%5D" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a> for &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h3></section><section id="impl-ByteSlice-for-%26mut+%5Bu8%5D" class="impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#236">Source</a><a href="#impl-ByteSlice-for-%26mut+%5Bu8%5D" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a> for &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]</h3></section><section id="impl-ByteSlice-for-Ref%3C'_,+%5Bu8%5D%3E" class="impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#324">Source</a><a href="#impl-ByteSlice-for-Ref%3C'_,+%5Bu8%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><'_, [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]></h3></section><section id="impl-ByteSlice-for-RefMut%3C'_,+%5Bu8%5D%3E" class="impl"><a class="src rightside" href="../../src/zerocopy/byte_slice.rs.html#344">Source</a><a href="#impl-ByteSlice-for-RefMut%3C'_,+%5Bu8%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/cell/struct.RefMut.html" title="struct core::cell::RefMut">RefMut</a><'_, [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>]></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/zerocopy/byte_slice/trait.ByteSlice.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |