263 lines
82 KiB
HTML
263 lines
82 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 typed reference derived from a byte slice."><title>Ref in zerocopy - 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 struct"><!--[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="#">Ref</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="#">Ref</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.bytes" title="bytes">bytes</a></li><li><a href="#method.bytes_mut" title="bytes_mut">bytes_mut</a></li><li><a href="#method.from_bytes" title="from_bytes">from_bytes</a></li><li><a href="#method.from_bytes_with_elems" title="from_bytes_with_elems">from_bytes_with_elems</a></li><li><a href="#method.from_prefix" title="from_prefix">from_prefix</a></li><li><a href="#method.from_prefix_with_elems" title="from_prefix_with_elems">from_prefix_with_elems</a></li><li><a href="#method.from_suffix" title="from_suffix">from_suffix</a></li><li><a href="#method.from_suffix_with_elems" title="from_suffix_with_elems">from_suffix_with_elems</a></li><li><a href="#method.into_mut" title="into_mut">into_mut</a></li><li><a href="#method.into_ref" title="into_ref">into_ref</a></li><li><a href="#method.read" title="read">read</a></li><li><a href="#method.write" title="write">write</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-Ref%3CB,+T%3E" title="Clone">Clone</a></li><li><a href="#impl-Copy-for-Ref%3CB,+T%3E" title="Copy">Copy</a></li><li><a href="#impl-Debug-for-Ref%3CB,+T%3E" title="Debug">Debug</a></li><li><a href="#impl-Deref-for-Ref%3CB,+T%3E" title="Deref">Deref</a></li><li><a href="#impl-DerefMut-for-Ref%3CB,+T%3E" title="DerefMut">DerefMut</a></li><li><a href="#impl-Display-for-Ref%3CB,+T%3E" title="Display">Display</a></li><li><a href="#impl-Eq-for-Ref%3CB,+T%3E" title="Eq">Eq</a></li><li><a href="#impl-Ord-for-Ref%3CB,+T%3E" title="Ord">Ord</a></li><li><a href="#impl-PartialEq-for-Ref%3CB,+T%3E" title="PartialEq">PartialEq</a></li><li><a href="#impl-PartialOrd-for-Ref%3CB,+T%3E" title="PartialOrd">PartialOrd</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Ref%3CB,+T%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Ref%3CB,+T%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Ref%3CB,+T%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Ref%3CB,+T%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Ref%3CB,+T%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Ref%3CB,+T%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-Receiver-for-P" title="Receiver">Receiver</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate zerocopy</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></div><h1>Struct <span class="struct">Ref</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/ref.rs.html#60-66">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Ref<B, 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>>(<span class="comment">/* private fields */</span>);</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A typed reference derived from a byte slice.</p>
|
|
<p>A <code>Ref<B, T></code> is a reference to a <code>T</code> which is stored in a byte slice, <code>B</code>.
|
|
Unlike a native reference (<code>&T</code> or <code>&mut T</code>), <code>Ref<B, T></code> has the same
|
|
mutability as the byte slice it was constructed from (<code>B</code>).</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p><code>Ref</code> can be used to treat a sequence of bytes as a structured type, and
|
|
to read and write the fields of that type as if the byte slice reference
|
|
were simply a reference to that type.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::<span class="kw-2">*</span>;
|
|
|
|
<span class="attr">#[derive(FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
|
|
#[repr(C)]
|
|
</span><span class="kw">struct </span>UdpHeader {
|
|
src_port: [u8; <span class="number">2</span>],
|
|
dst_port: [u8; <span class="number">2</span>],
|
|
length: [u8; <span class="number">2</span>],
|
|
checksum: [u8; <span class="number">2</span>],
|
|
}
|
|
|
|
<span class="attr">#[derive(FromBytes, IntoBytes, KnownLayout, Immutable, Unaligned)]
|
|
#[repr(C, packed)]
|
|
</span><span class="kw">struct </span>UdpPacket {
|
|
header: UdpHeader,
|
|
body: [u8],
|
|
}
|
|
|
|
<span class="kw">impl </span>UdpPacket {
|
|
<span class="kw">pub fn </span>parse<B: ByteSlice>(bytes: B) -> <span class="prelude-ty">Option</span><Ref<B, UdpPacket>> {
|
|
Ref::from_bytes(bytes).ok()
|
|
}
|
|
}</code></pre></div></div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#267-317">Source</a><a href="#impl-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_bytes" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#307-316">Source</a><h4 class="code-header">pub fn <a href="#method.from_bytes" class="fn">from_bytes</a>(source: B) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T>, <a class="type" href="error/type.CastError.html" title="type zerocopy::error::CastError">CastError</a><B, T>></h4></section></summary><div class="docblock"><p>Constructs a <code>Ref</code> from a byte slice.</p>
|
|
<p>If the length of <code>source</code> is not a <a href="trait.KnownLayout.html#what-is-a-valid-size" title="trait zerocopy::KnownLayout">valid size of <code>T</code></a>, or
|
|
if <code>source</code> is not appropriately aligned for <code>T</code>, this returns <code>Err</code>. If
|
|
<a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>T: Unaligned</code></a>, you can <a href="error/struct.SizeError.html#method.from-1">infallibly discard the alignment
|
|
error</a>.</p>
|
|
<p><code>T</code> may be a sized type, a slice, or a <a href="trait.KnownLayout.html#dynamically-sized-types" title="trait zerocopy::KnownLayout">slice DST</a>.</p>
|
|
<h5 id="compile-time-assertions"><a class="doc-anchor" href="#compile-time-assertions">§</a>Compile-Time Assertions</h5>
|
|
<p>This method cannot yet be used on unsized types whose dynamically-sized
|
|
component is zero-sized. Attempting to use this method on such types
|
|
results in a compile-time assertion error; e.g.:</p>
|
|
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::<span class="kw-2">*</span>;
|
|
|
|
<span class="attr">#[derive(Immutable, KnownLayout)]
|
|
#[repr(C)]
|
|
</span><span class="kw">struct </span>ZSTy {
|
|
leading_sized: u16,
|
|
trailing_dst: [()],
|
|
}
|
|
|
|
<span class="kw">let _ </span>= Ref::<<span class="kw">_</span>, ZSTy>::from_bytes(<span class="kw-2">&</span><span class="string">b"UU"</span>[..]); <span class="comment">// ⚠ Compile Error!</span></code></pre></div></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-1" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#319-447">Source</a><a href="#impl-Ref%3CB,+T%3E-1" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.SplitByteSlice.html" title="trait zerocopy::byte_slice::SplitByteSlice">SplitByteSlice</a>,
|
|
T: <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_prefix" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#361-386">Source</a><h4 class="code-header">pub fn <a href="#method.from_prefix" class="fn">from_prefix</a>(source: B) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(<a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T>, B), <a class="type" href="error/type.CastError.html" title="type zerocopy::error::CastError">CastError</a><B, T>></h4></section></summary><div class="docblock"><p>Constructs a <code>Ref</code> from the prefix of a byte slice.</p>
|
|
<p>This method computes the <a href="trait.KnownLayout.html#what-is-a-valid-size" title="trait zerocopy::KnownLayout">largest possible size of <code>T</code></a> that
|
|
can fit in the leading bytes of <code>source</code>, then attempts to return both a
|
|
<code>Ref</code> to those bytes, and a reference to the remaining bytes. If there
|
|
are insufficient bytes, or if <code>source</code> is not appropriately aligned,
|
|
this returns <code>Err</code>. If <a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>T: Unaligned</code></a>, you can
|
|
<a href="error/struct.SizeError.html#method.from-1">infallibly discard the alignment error</a>.</p>
|
|
<p><code>T</code> may be a sized type, a slice, or a <a href="trait.KnownLayout.html#dynamically-sized-types" title="trait zerocopy::KnownLayout">slice DST</a>.</p>
|
|
<h5 id="compile-time-assertions-1"><a class="doc-anchor" href="#compile-time-assertions-1">§</a>Compile-Time Assertions</h5>
|
|
<p>This method cannot yet be used on unsized types whose dynamically-sized
|
|
component is zero-sized. Attempting to use this method on such types
|
|
results in a compile-time assertion error; e.g.:</p>
|
|
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::<span class="kw-2">*</span>;
|
|
|
|
<span class="attr">#[derive(Immutable, KnownLayout)]
|
|
#[repr(C)]
|
|
</span><span class="kw">struct </span>ZSTy {
|
|
leading_sized: u16,
|
|
trailing_dst: [()],
|
|
}
|
|
|
|
<span class="kw">let _ </span>= Ref::<<span class="kw">_</span>, ZSTy>::from_prefix(<span class="kw-2">&</span><span class="string">b"UU"</span>[..]); <span class="comment">// ⚠ Compile Error!</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.from_suffix" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#426-446">Source</a><h4 class="code-header">pub fn <a href="#method.from_suffix" class="fn">from_suffix</a>(source: B) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(B, <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T>), <a class="type" href="error/type.CastError.html" title="type zerocopy::error::CastError">CastError</a><B, T>></h4></section></summary><div class="docblock"><p>Constructs a <code>Ref</code> from the suffix of a byte slice.</p>
|
|
<p>This method computes the <a href="trait.KnownLayout.html#what-is-a-valid-size" title="trait zerocopy::KnownLayout">largest possible size of <code>T</code></a> that
|
|
can fit in the trailing bytes of <code>source</code>, then attempts to return both
|
|
a <code>Ref</code> to those bytes, and a reference to the preceding bytes. If there
|
|
are insufficient bytes, or if that suffix of <code>source</code> is not
|
|
appropriately aligned, this returns <code>Err</code>. If <a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>T: Unaligned</code></a>, you can <a href="error/struct.SizeError.html#method.from-1">infallibly discard the alignment
|
|
error</a>.</p>
|
|
<p><code>T</code> may be a sized type, a slice, or a <a href="trait.KnownLayout.html#dynamically-sized-types" title="trait zerocopy::KnownLayout">slice DST</a>.</p>
|
|
<h5 id="compile-time-assertions-2"><a class="doc-anchor" href="#compile-time-assertions-2">§</a>Compile-Time Assertions</h5>
|
|
<p>This method cannot yet be used on unsized types whose dynamically-sized
|
|
component is zero-sized. Attempting to use this method on such types
|
|
results in a compile-time assertion error; e.g.:</p>
|
|
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::<span class="kw-2">*</span>;
|
|
|
|
<span class="attr">#[derive(Immutable, KnownLayout)]
|
|
#[repr(C)]
|
|
</span><span class="kw">struct </span>ZSTy {
|
|
leading_sized: u16,
|
|
trailing_dst: [()],
|
|
}
|
|
|
|
<span class="kw">let _ </span>= Ref::<<span class="kw">_</span>, ZSTy>::from_suffix(<span class="kw-2">&</span><span class="string">b"UU"</span>[..]); <span class="comment">// ⚠ Compile Error!</span></code></pre></div></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-2" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#449-498">Source</a><a href="#impl-Ref%3CB,+T%3E-2" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a><PointerMetadata = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_bytes_with_elems" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#487-497">Source</a><h4 class="code-header">pub fn <a href="#method.from_bytes_with_elems" class="fn">from_bytes_with_elems</a>(
|
|
source: B,
|
|
count: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T>, <a class="type" href="error/type.CastError.html" title="type zerocopy::error::CastError">CastError</a><B, T>></h4></section></summary><div class="docblock"><p>Constructs a <code>Ref</code> from the given bytes with DST length equal to <code>count</code>
|
|
without copying.</p>
|
|
<p>This method attempts to return a <code>Ref</code> to the prefix of <code>source</code>
|
|
interpreted as a <code>T</code> with <code>count</code> trailing elements, and a reference to
|
|
the remaining bytes. If the length of <code>source</code> is not equal to the size
|
|
of <code>Self</code> with <code>count</code> elements, or if <code>source</code> is not appropriately
|
|
aligned, this returns <code>Err</code>. If <a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>T: Unaligned</code></a>, you can
|
|
<a href="error/struct.SizeError.html#method.from-1">infallibly discard the alignment error</a>.</p>
|
|
<h5 id="compile-time-assertions-3"><a class="doc-anchor" href="#compile-time-assertions-3">§</a>Compile-Time Assertions</h5>
|
|
<p>This method cannot yet be used on unsized types whose dynamically-sized
|
|
component is zero-sized. Attempting to use this method on such types
|
|
results in a compile-time assertion error; e.g.:</p>
|
|
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::<span class="kw-2">*</span>;
|
|
|
|
<span class="attr">#[derive(Immutable, KnownLayout)]
|
|
#[repr(C)]
|
|
</span><span class="kw">struct </span>ZSTy {
|
|
leading_sized: u16,
|
|
trailing_dst: [()],
|
|
}
|
|
|
|
<span class="kw">let _ </span>= Ref::<<span class="kw">_</span>, ZSTy>::from_bytes_with_elems(<span class="kw-2">&</span><span class="string">b"UU"</span>[..], <span class="number">42</span>); <span class="comment">// ⚠ Compile Error!</span></code></pre></div></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-3" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#500-603">Source</a><a href="#impl-Ref%3CB,+T%3E-3" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.SplitByteSlice.html" title="trait zerocopy::byte_slice::SplitByteSlice">SplitByteSlice</a>,
|
|
T: <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a><PointerMetadata = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_prefix_with_elems" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#538-549">Source</a><h4 class="code-header">pub fn <a href="#method.from_prefix_with_elems" class="fn">from_prefix_with_elems</a>(
|
|
source: B,
|
|
count: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(<a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T>, B), <a class="type" href="error/type.CastError.html" title="type zerocopy::error::CastError">CastError</a><B, T>></h4></section></summary><div class="docblock"><p>Constructs a <code>Ref</code> from the prefix of the given bytes with DST
|
|
length equal to <code>count</code> without copying.</p>
|
|
<p>This method attempts to return a <code>Ref</code> to the prefix of <code>source</code>
|
|
interpreted as a <code>T</code> with <code>count</code> trailing elements, and a reference to
|
|
the remaining bytes. If there are insufficient bytes, or if <code>source</code> is
|
|
not appropriately aligned, this returns <code>Err</code>. If <a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>T: Unaligned</code></a>, you can <a href="error/struct.SizeError.html#method.from-1">infallibly discard the alignment
|
|
error</a>.</p>
|
|
<h5 id="compile-time-assertions-4"><a class="doc-anchor" href="#compile-time-assertions-4">§</a>Compile-Time Assertions</h5>
|
|
<p>This method cannot yet be used on unsized types whose dynamically-sized
|
|
component is zero-sized. Attempting to use this method on such types
|
|
results in a compile-time assertion error; e.g.:</p>
|
|
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::<span class="kw-2">*</span>;
|
|
|
|
<span class="attr">#[derive(Immutable, KnownLayout)]
|
|
#[repr(C)]
|
|
</span><span class="kw">struct </span>ZSTy {
|
|
leading_sized: u16,
|
|
trailing_dst: [()],
|
|
}
|
|
|
|
<span class="kw">let _ </span>= Ref::<<span class="kw">_</span>, ZSTy>::from_prefix_with_elems(<span class="kw-2">&</span><span class="string">b"UU"</span>[..], <span class="number">42</span>); <span class="comment">// ⚠ Compile Error!</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.from_suffix_with_elems" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#584-602">Source</a><h4 class="code-header">pub fn <a href="#method.from_suffix_with_elems" class="fn">from_suffix_with_elems</a>(
|
|
source: B,
|
|
count: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(B, <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T>), <a class="type" href="error/type.CastError.html" title="type zerocopy::error::CastError">CastError</a><B, T>></h4></section></summary><div class="docblock"><p>Constructs a <code>Ref</code> from the suffix of the given bytes with DST length
|
|
equal to <code>count</code> without copying.</p>
|
|
<p>This method attempts to return a <code>Ref</code> to the suffix of <code>source</code>
|
|
interpreted as a <code>T</code> with <code>count</code> trailing elements, and a reference to
|
|
the preceding bytes. If there are insufficient bytes, or if that suffix
|
|
of <code>source</code> is not appropriately aligned, this returns <code>Err</code>. If <a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>T: Unaligned</code></a>, you can <a href="error/struct.SizeError.html#method.from-1">infallibly discard the alignment
|
|
error</a>.</p>
|
|
<h5 id="compile-time-assertions-5"><a class="doc-anchor" href="#compile-time-assertions-5">§</a>Compile-Time Assertions</h5>
|
|
<p>This method cannot yet be used on unsized types whose dynamically-sized
|
|
component is zero-sized. Attempting to use this method on such types
|
|
results in a compile-time assertion error; e.g.:</p>
|
|
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::<span class="kw-2">*</span>;
|
|
|
|
<span class="attr">#[derive(Immutable, KnownLayout)]
|
|
#[repr(C)]
|
|
</span><span class="kw">struct </span>ZSTy {
|
|
leading_sized: u16,
|
|
trailing_dst: [()],
|
|
}
|
|
|
|
<span class="kw">let _ </span>= Ref::<<span class="kw">_</span>, ZSTy>::from_suffix_with_elems(<span class="kw-2">&</span><span class="string">b"UU"</span>[..], <span class="number">42</span>); <span class="comment">// ⚠ Compile Error!</span></code></pre></div></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-4" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#605-651">Source</a><a href="#impl-Ref%3CB,+T%3E-4" class="anchor">§</a><h3 class="code-header">impl<'a, B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: 'a + <a class="trait" href="byte_slice/trait.IntoByteSlice.html" title="trait zerocopy::byte_slice::IntoByteSlice">IntoByteSlice</a><'a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_ref" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#619-650">Source</a><h4 class="code-header">pub fn <a href="#method.into_ref" class="fn">into_ref</a>(r: Self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&'a T</a></h4></section></summary><div class="docblock"><p>Converts this <code>Ref</code> into a reference.</p>
|
|
<p><code>into_ref</code> consumes the <code>Ref</code>, and returns a reference to <code>T</code>.</p>
|
|
<p>Note: this is an associated function, which means that you have to call
|
|
it as <code>Ref::into_ref(r)</code> instead of <code>r.into_ref()</code>. This is so that
|
|
there is no conflict with a method on the inner type.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-5" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#653-706">Source</a><a href="#impl-Ref%3CB,+T%3E-5" class="anchor">§</a><h3 class="code-header">impl<'a, B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: 'a + <a class="trait" href="byte_slice/trait.IntoByteSliceMut.html" title="trait zerocopy::byte_slice::IntoByteSliceMut">IntoByteSliceMut</a><'a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="trait.IntoBytes.html" title="trait zerocopy::IntoBytes">IntoBytes</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into_mut" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#667-705">Source</a><h4 class="code-header">pub fn <a href="#method.into_mut" class="fn">into_mut</a>(r: Self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&'a mut T</a></h4></section></summary><div class="docblock"><p>Converts this <code>Ref</code> into a mutable reference.</p>
|
|
<p><code>into_mut</code> consumes the <code>Ref</code>, and returns a mutable reference to <code>T</code>.</p>
|
|
<p>Note: this is an associated function, which means that you have to call
|
|
it as <code>Ref::into_mut(r)</code> instead of <code>r.into_mut()</code>. This is so that
|
|
there is no conflict with a method on the inner type.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-6" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#708-724">Source</a><a href="#impl-Ref%3CB,+T%3E-6" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bytes" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#719-723">Source</a><h4 class="code-header">pub fn <a href="#method.bytes" class="fn">bytes</a>(r: &Self) -> &[<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>Gets the underlying bytes.</p>
|
|
<p>Note: this is an associated function, which means that you have to call
|
|
it as <code>Ref::bytes(r)</code> instead of <code>r.bytes()</code>. This is so that there is
|
|
no conflict with a method on the inner type.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-7" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#726-742">Source</a><a href="#impl-Ref%3CB,+T%3E-7" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSliceMut.html" title="trait zerocopy::byte_slice::ByteSliceMut">ByteSliceMut</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bytes_mut" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#737-741">Source</a><h4 class="code-header">pub fn <a href="#method.bytes_mut" class="fn">bytes_mut</a>(r: &mut Self) -> &mut [<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>Gets the underlying bytes mutably.</p>
|
|
<p>Note: this is an associated function, which means that you have to call
|
|
it as <code>Ref::bytes_mut(r)</code> instead of <code>r.bytes_mut()</code>. This is so that
|
|
there is no conflict with a method on the inner type.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-8" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#744-767">Source</a><a href="#impl-Ref%3CB,+T%3E-8" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.read" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#756-766">Source</a><h4 class="code-header">pub fn <a href="#method.read" class="fn">read</a>(r: &Self) -> T</h4></section></summary><div class="docblock"><p>Reads a copy of <code>T</code>.</p>
|
|
<p>Note: this is an associated function, which means that you have to call
|
|
it as <code>Ref::read(r)</code> instead of <code>r.read()</code>. This is so that there is no
|
|
conflict with a method on the inner type.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ref%3CB,+T%3E-9" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#769-792">Source</a><a href="#impl-Ref%3CB,+T%3E-9" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSliceMut.html" title="trait zerocopy::byte_slice::ByteSliceMut">ByteSliceMut</a>,
|
|
T: <a class="trait" href="trait.IntoBytes.html" title="trait zerocopy::IntoBytes">IntoBytes</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.write" class="method"><a class="src rightside" href="../src/zerocopy/ref.rs.html#780-791">Source</a><h4 class="code-header">pub fn <a href="#method.write" class="fn">write</a>(r: &mut Self, t: T)</h4></section></summary><div class="docblock"><p>Writes the bytes of <code>t</code> and then forgets <code>t</code>.</p>
|
|
<p>Note: this is an associated function, which means that you have to call
|
|
it as <code>Ref::write(r, t)</code> instead of <code>r.write(t)</code>. This is so that there
|
|
is no conflict with a method on the inner type.</p>
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#179-187">Source</a><a href="#impl-Clone-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B: <a class="trait" href="byte_slice/trait.CloneableByteSlice.html" title="trait zerocopy::byte_slice::CloneableByteSlice">CloneableByteSlice</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</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="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#181-186">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T></h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#896-906">Source</a><a href="#impl-Debug-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<T, B> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#902-905">Source</a><a href="#method.fmt-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deref-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#794-832">Source</a><a href="#impl-Deref-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <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> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#799">Source</a><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = T</h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#801-831">Source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-DerefMut-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#834-882">Source</a><a href="#impl-DerefMut-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSliceMut.html" title="trait zerocopy::byte_slice::ByteSliceMut">ByteSliceMut</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="trait.IntoBytes.html" title="trait zerocopy::IntoBytes">IntoBytes</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#843-881">Source</a><a href="#method.deref_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.DerefMut.html#tymethod.deref_mut" class="fn">deref_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably dereferences the value.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Display-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#884-894">Source</a><a href="#impl-Display-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<T, B> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#890-893">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Display.html#tymethod.fmt" class="fn">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Ord-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#926-937">Source</a><a href="#impl-Ord-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<T, B> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.cmp" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#932-936">Source</a><a href="#method.cmp" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#tymethod.cmp" class="fn">cmp</a>(&self, other: &Self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section></summary><div class='docblock'>This method returns an <a href="https://doc.rust-lang.org/1.93.1/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering"><code>Ordering</code></a> between <code>self</code> and <code>other</code>. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#tymethod.cmp">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.max" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.21.0">1.21.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#1021-1023">Source</a></span><a href="#method.max" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#method.max" class="fn">max</a>(self, other: Self) -> Self<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>,</div></h4></section></summary><div class='docblock'>Compares and returns the maximum of two values. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#method.max">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.min" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.21.0">1.21.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#1060-1062">Source</a></span><a href="#method.min" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#method.min" class="fn">min</a>(self, other: Self) -> Self<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>,</div></h4></section></summary><div class='docblock'>Compares and returns the minimum of two values. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#method.min">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clamp" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.50.0">1.50.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#1086-1088">Source</a></span><a href="#method.clamp" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#method.clamp" class="fn">clamp</a>(self, min: Self, max: Self) -> Self<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>,</div></h4></section></summary><div class='docblock'>Restrict a value to a certain interval. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Ord.html#method.clamp">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#915-924">Source</a><a href="#impl-PartialEq-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<T, B> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#921-923">Source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &Self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#264">Source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>!=</code>. The default implementation is almost always sufficient,
|
|
and should not be overridden without very good reason.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialOrd-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#939-950">Source</a><a href="#impl-PartialOrd-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<T, B> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.partial_cmp" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#945-949">Source</a><a href="#method.partial_cmp" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fn">partial_cmp</a>(&self, other: &Self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.93.1/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.lt" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#1398">Source</a></span><a href="#method.lt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.lt" class="fn">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.le" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#1416">Source</a></span><a href="#method.le" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.le" class="fn">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the
|
|
<code><=</code> operator. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.gt" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#1434">Source</a></span><a href="#method.gt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.gt" class="fn">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code>
|
|
operator. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.ge" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/cmp.rs.html#1452">Source</a></span><a href="#method.ge" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.ge" class="fn">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by
|
|
the <code>>=</code> operator. <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></div></details></div></details><section id="impl-Copy-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#192">Source</a><a href="#impl-Copy-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B: <a class="trait" href="byte_slice/trait.CopyableByteSlice.html" title="trait zerocopy::byte_slice::CopyableByteSlice">CopyableByteSlice</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</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="https://doc.rust-lang.org/1.93.1/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T></h3></section><section id="impl-Eq-for-Ref%3CB,+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/ref.rs.html#908-913">Source</a><a href="#impl-Eq-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<T, B> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="byte_slice/trait.ByteSlice.html" title="trait zerocopy::byte_slice::ByteSlice">ByteSlice</a>,
|
|
T: <a class="trait" href="trait.FromBytes.html" title="trait zerocopy::FromBytes">FromBytes</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="trait.KnownLayout.html" title="trait zerocopy::KnownLayout">KnownLayout</a> + <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</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>,</div></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Ref%3CB,+T%3E" class="impl"><a href="#impl-Freeze-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</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>,</div></h3></section><section id="impl-RefUnwindSafe-for-Ref%3CB,+T%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</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>,</div></h3></section><section id="impl-Send-for-Ref%3CB,+T%3E" class="impl"><a href="#impl-Send-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</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>,</div></h3></section><section id="impl-Sync-for-Ref%3CB,+T%3E" class="impl"><a href="#impl-Sync-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</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>,</div></h3></section><section id="impl-Unpin-for-Ref%3CB,+T%3E" class="impl"><a href="#impl-Unpin-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</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>,</div></h3></section><section id="impl-UnwindSafe-for-Ref%3CB,+T%3E" class="impl"><a href="#impl-UnwindSafe-for-Ref%3CB,+T%3E" class="anchor">§</a><h3 class="code-header">impl<B, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Ref.html" title="struct zerocopy::Ref">Ref</a><B, T><div class="where">where
|
|
B: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</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>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
T: 'static + ?<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></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#547">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#549">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dest: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|
<p>That is, this conversion is whatever the implementation of
|
|
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Receiver-for-P" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/ops/deref.rs.html#378-380">Source</a><a href="#impl-Receiver-for-P" class="anchor">§</a><h3 class="code-header">impl<P, T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Receiver.html" title="trait core::ops::deref::Receiver">Receiver</a> for P<div class="where">where
|
|
P: <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 = 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>,
|
|
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>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/ops/deref.rs.html#382">Source</a><a href="#associatedtype.Target-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/ops/deref/trait.Receiver.html#associatedtype.Target" class="associatedtype">Target</a> = T</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>arbitrary_self_types</code>)</span></div></span><div class='docblock'>The target type on which the method may be called.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |