hobokenchicken/GopherGate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
710878f1a3ea4f49ad3469b215ecef922c46914d
GopherGate/target/doc/zerocopy/struct.Split.html
hobokenchicken 49701c85ad Adding large folders
2026-02-26 12:00:21 -05:00

299 lines
53 KiB
HTML
Raw Blame History

<!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 `T` that has been split into two possibly-overlapping parts."><title>Split 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="#">Split</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="#">Split</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.via_immutable" title="via_immutable">via_immutable</a></li><li><a href="#method.via_into_bytes" title="via_into_bytes">via_into_bytes</a></li><li><a href="#method.via_into_bytes-1" title="via_into_bytes">via_into_bytes</a></li><li><a href="#method.via_runtime_check" title="via_runtime_check">via_runtime_check</a></li><li><a href="#method.via_runtime_check-1" title="via_runtime_check">via_runtime_check</a></li><li><a href="#method.via_unaligned" title="via_unaligned">via_unaligned</a></li><li><a href="#method.via_unaligned-1" title="via_unaligned">via_unaligned</a></li><li><a href="#method.via_unchecked" title="via_unchecked">via_unchecked</a></li><li><a href="#method.via_unchecked-1" title="via_unchecked">via_unchecked</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Split%3CT%3E" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Split%3CT%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Split%3CT%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Split%3CT%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Split%3CT%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Split%3CT%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Split%3CT%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&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</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">Split</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/zerocopy/split_at.rs.html#232-242">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Split&lt;T&gt; { <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 <code>T</code> that has been split into two possibly-overlapping parts.</p>
<p>For some dynamically sized types, the padding that appears after the
trailing slice field <a href="trait.KnownLayout.html#slice-dst-layout" title="trait zerocopy::KnownLayout">is a dynamic function of the trailing slice
length</a>. If <code>T</code> is split at a length that
requires trailing padding, the trailing padding of the left part of the
split <code>T</code> will overlap the right part. If <code>T</code> is a mutable reference or
permits interior mutation, you must ensure that the left and right parts do
not overlap. You can do this at zero-cost using using
<a href="struct.Split.html#method.via_immutable" title="method zerocopy::Split::via_immutable"><code>Self::via_immutable</code></a>, <a href="struct.Split.html#method.via_into_bytes" title="method zerocopy::Split::via_into_bytes"><code>Self::via_into_bytes</code></a>, or
<a href="struct.Split.html#method.via_unaligned" title="method zerocopy::Split::via_unaligned"><code>Self::via_unaligned</code></a>, or with a dynamic check by using
<a href="struct.Split.html#method.via_runtime_check" title="method zerocopy::Split::via_runtime_check"><code>Self::via_runtime_check</code></a>.</p>
</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-Split%3C%26T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#256-490">Source</a><a href="#impl-Split%3C%26T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, T&gt; <a class="struct" href="struct.Split.html" title="struct zerocopy::Split">Split</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a T</a>&gt;<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> + <a class="trait" href="trait.SplitAt.html" title="trait zerocopy::SplitAt">SplitAt</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.via_immutable" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#305-311">Source</a><h4 class="code-header">pub fn <a href="#method.via_immutable" class="fn">via_immutable</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a T</a>, &amp;'a [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>])<div class="where">where
T: <a class="trait" href="trait.Immutable.html" title="trait zerocopy::Immutable">Immutable</a>,</div></h4></section></summary><div class="docblock"><p>Produces the split parts of <code>self</code>, using <a href="trait.Immutable.html" title="trait zerocopy::Immutable"><code>Immutable</code></a> to ensure that
it is sound to have concurrent references to both parts.</p>
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::{SplitAt, FromBytes};
<span class="attr">#[derive(SplitAt, FromBytes, KnownLayout, Immutable)]
#[repr(C)]
</span><span class="kw">struct </span>Packet {
length: u8,
body: [u8],
}
<span class="comment">// These bytes encode a `Packet`.
</span><span class="kw">let </span>bytes = <span class="kw-2">&amp;</span>[<span class="number">4</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>][..];
<span class="kw">let </span>packet = Packet::ref_from_bytes(bytes).unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
<span class="comment">// Attempt to split `packet` at `length`.
</span><span class="kw">let </span>split = packet.split_at(packet.length <span class="kw">as </span>usize).unwrap();
<span class="comment">// Use the `Immutable` bound on `Packet` to prove that it's okay to
// return concurrent references to `packet` and `rest`.
</span><span class="kw">let </span>(packet, rest) = split.via_immutable();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
<span class="macro">assert_eq!</span>(rest, [<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.via_into_bytes" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#350-356">Source</a><h4 class="code-header">pub fn <a href="#method.via_into_bytes" class="fn">via_into_bytes</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a T</a>, &amp;'a [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>])<div class="where">where
T: <a class="trait" href="trait.IntoBytes.html" title="trait zerocopy::IntoBytes">IntoBytes</a>,</div></h4></section></summary><div class="docblock"><p>Produces the split parts of <code>self</code>, using <a href="trait.IntoBytes.html" title="trait zerocopy::IntoBytes"><code>IntoBytes</code></a> to ensure that
it is sound to have concurrent references to both parts.</p>
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::{SplitAt, FromBytes};
<span class="attr">#[derive(SplitAt, FromBytes, KnownLayout, Immutable, IntoBytes)]
#[repr(C)]
</span><span class="kw">struct </span>Packet&lt;B: <span class="question-mark">?</span>Sized&gt; {
length: u8,
body: B,
}
<span class="comment">// These bytes encode a `Packet`.
</span><span class="kw">let </span>bytes = <span class="kw-2">&amp;</span>[<span class="number">4</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>][..];
<span class="kw">let </span>packet = Packet::&lt;[u8]&gt;::ref_from_bytes(bytes).unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
<span class="comment">// Attempt to split `packet` at `length`.
</span><span class="kw">let </span>split = packet.split_at(packet.length <span class="kw">as </span>usize).unwrap();
<span class="comment">// Use the `IntoBytes` bound on `Packet` to prove that it's okay to
// return concurrent references to `packet` and `rest`.
</span><span class="kw">let </span>(packet, rest) = split.via_into_bytes();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
<span class="macro">assert_eq!</span>(rest, [<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.via_unaligned" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#395-401">Source</a><h4 class="code-header">pub fn <a href="#method.via_unaligned" class="fn">via_unaligned</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a T</a>, &amp;'a [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>])<div class="where">where
T: <a class="trait" href="trait.Unaligned.html" title="trait zerocopy::Unaligned">Unaligned</a>,</div></h4></section></summary><div class="docblock"><p>Produces the split parts of <code>self</code>, using <a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>Unaligned</code></a> to ensure that
it is sound to have concurrent references to both parts.</p>
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::{SplitAt, FromBytes};
<span class="attr">#[derive(SplitAt, FromBytes, KnownLayout, Immutable, Unaligned)]
#[repr(C)]
</span><span class="kw">struct </span>Packet {
length: u8,
body: [u8],
}
<span class="comment">// These bytes encode a `Packet`.
</span><span class="kw">let </span>bytes = <span class="kw-2">&amp;</span>[<span class="number">4</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>][..];
<span class="kw">let </span>packet = Packet::ref_from_bytes(bytes).unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
<span class="comment">// Attempt to split `packet` at `length`.
</span><span class="kw">let </span>split = packet.split_at(packet.length <span class="kw">as </span>usize).unwrap();
<span class="comment">// Use the `Unaligned` bound on `Packet` to prove that it's okay to
// return concurrent references to `packet` and `rest`.
</span><span class="kw">let </span>(packet, rest) = split.via_unaligned();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
<span class="macro">assert_eq!</span>(rest, [<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.via_runtime_check" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#464-469">Source</a><h4 class="code-header">pub fn <a href="#method.via_runtime_check" class="fn">via_runtime_check</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a T</a>, &amp;'a [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>]), Self&gt;</h4></section></summary><div class="docblock"><p>Produces the split parts of <code>self</code>, using a dynamic check to ensure that
it is sound to have concurrent references to both parts. You should
prefer using <a href="struct.Split.html#method.via_immutable" title="method zerocopy::Split::via_immutable"><code>Self::via_immutable</code></a>, <a href="struct.Split.html#method.via_into_bytes" title="method zerocopy::Split::via_into_bytes"><code>Self::via_into_bytes</code></a>, or
<a href="struct.Split.html#method.via_unaligned" title="method zerocopy::Split::via_unaligned"><code>Self::via_unaligned</code></a>, which have no runtime cost.</p>
<p>Note that this check is overly conservative if <code>T</code> is <a href="trait.Immutable.html" title="trait zerocopy::Immutable"><code>Immutable</code></a>; for
some types, this check will reject some splits which
<a href="struct.Split.html#method.via_immutable" title="method zerocopy::Split::via_immutable"><code>Self::via_immutable</code></a> will accept.</p>
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::{SplitAt, FromBytes, IntoBytes, network_endian::U16};
<span class="attr">#[derive(SplitAt, FromBytes, KnownLayout, Immutable, Debug)]
#[repr(C, align(<span class="number">2</span>))]
</span><span class="kw">struct </span>Packet {
length: U16,
body: [u8],
}
<span class="comment">// These bytes encode a `Packet`.
</span><span class="kw">let </span>bytes = [
<span class="number">4u16</span>.to_be(),
<span class="number">1u16</span>.to_be(),
<span class="number">2u16</span>.to_be(),
<span class="number">3u16</span>.to_be(),
<span class="number">4u16</span>.to_be()
];
<span class="kw">let </span>packet = Packet::ref_from_bytes(bytes.as_bytes()).unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">4</span>]);
<span class="comment">// Attempt to split `packet` at `length`.
</span><span class="kw">let </span>split = packet.split_at(packet.length.into()).unwrap();
<span class="comment">// Use a dynamic check to prove that it's okay to return concurrent
// references to `packet` and `rest`.
</span><span class="kw">let </span>(packet, rest) = split.via_runtime_check().unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">2</span>]);
<span class="macro">assert_eq!</span>(rest, [<span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">4</span>]);
<span class="comment">// Attempt to split `packet` at `length - 1`.
</span><span class="kw">let </span>idx = packet.length.get() - <span class="number">1</span>;
<span class="kw">let </span>split = packet.split_at(idx <span class="kw">as </span>usize).unwrap();
<span class="comment">// Attempt (and fail) to use a dynamic check to prove that it's okay
// to return concurrent references to `packet` and `rest`. Note that
// this is a case of `via_runtime_check` being overly conservative.
// Although the left and right parts indeed overlap, the `Immutable`
// bound ensures that concurrently referencing these overlapping
// parts is sound.
</span><span class="macro">assert!</span>(split.via_runtime_check().is_err());</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.via_unchecked" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#483-489">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.via_unchecked" class="fn">via_unchecked</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a T</a>, &amp;'a [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>])</h4></section></summary><div class="docblock"><p>Unsafely produces the split parts of <code>self</code>.</p>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<p>If <code>T</code> permits interior mutation, the trailing padding bytes of the left
portion must not overlap the right portion. For some dynamically sized
types, the padding that appears after the trailing slice field <a href="trait.KnownLayout.html#slice-dst-layout" title="trait zerocopy::KnownLayout">is a
dynamic function of the trailing slice
length</a>. Thus, for some types, this
condition is dependent on the length of the left portion.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Split%3C%26mut+T%3E" class="impl"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#492-679">Source</a><a href="#impl-Split%3C%26mut+T%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, T&gt; <a class="struct" href="struct.Split.html" title="struct zerocopy::Split">Split</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a mut T</a>&gt;<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> + <a class="trait" href="trait.SplitAt.html" title="trait zerocopy::SplitAt">SplitAt</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.via_into_bytes-1" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#548-554">Source</a><h4 class="code-header">pub fn <a href="#method.via_into_bytes-1" class="fn">via_into_bytes</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a mut T</a>, &amp;'a mut [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>])<div class="where">where
T: <a class="trait" href="trait.IntoBytes.html" title="trait zerocopy::IntoBytes">IntoBytes</a>,</div></h4></section></summary><div class="docblock"><p>Produces the split parts of <code>self</code>, using <a href="trait.IntoBytes.html" title="trait zerocopy::IntoBytes"><code>IntoBytes</code></a> to ensure that
it is sound to have concurrent references to both parts.</p>
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::{SplitAt, FromBytes};
<span class="attr">#[derive(SplitAt, FromBytes, KnownLayout, IntoBytes)]
#[repr(C)]
</span><span class="kw">struct </span>Packet&lt;B: <span class="question-mark">?</span>Sized&gt; {
length: u8,
body: B,
}
<span class="comment">// These bytes encode a `Packet`.
</span><span class="kw">let </span><span class="kw-2">mut </span>bytes = <span class="kw-2">&amp;mut </span>[<span class="number">4</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>][..];
<span class="kw">let </span>packet = Packet::&lt;[u8]&gt;::mut_from_bytes(bytes).unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
{
<span class="comment">// Attempt to split `packet` at `length`.
</span><span class="kw">let </span>split = packet.split_at_mut(packet.length <span class="kw">as </span>usize).unwrap();
<span class="comment">// Use the `IntoBytes` bound on `Packet` to prove that it's okay to
// return concurrent references to `packet` and `rest`.
</span><span class="kw">let </span>(packet, rest) = split.via_into_bytes();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
<span class="macro">assert_eq!</span>(rest, [<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
rest.fill(<span class="number">0</span>);
}
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.via_unaligned-1" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#600-606">Source</a><h4 class="code-header">pub fn <a href="#method.via_unaligned-1" class="fn">via_unaligned</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a mut T</a>, &amp;'a mut [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>])<div class="where">where
T: <a class="trait" href="trait.Unaligned.html" title="trait zerocopy::Unaligned">Unaligned</a>,</div></h4></section></summary><div class="docblock"><p>Produces the split parts of <code>self</code>, using <a href="trait.Unaligned.html" title="trait zerocopy::Unaligned"><code>Unaligned</code></a> to ensure that
it is sound to have concurrent references to both parts.</p>
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::{SplitAt, FromBytes};
<span class="attr">#[derive(SplitAt, FromBytes, KnownLayout, IntoBytes, Unaligned)]
#[repr(C)]
</span><span class="kw">struct </span>Packet&lt;B: <span class="question-mark">?</span>Sized&gt; {
length: u8,
body: B,
}
<span class="comment">// These bytes encode a `Packet`.
</span><span class="kw">let </span><span class="kw-2">mut </span>bytes = <span class="kw-2">&amp;mut </span>[<span class="number">4</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>][..];
<span class="kw">let </span>packet = Packet::&lt;[u8]&gt;::mut_from_bytes(bytes).unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
{
<span class="comment">// Attempt to split `packet` at `length`.
</span><span class="kw">let </span>split = packet.split_at_mut(packet.length <span class="kw">as </span>usize).unwrap();
<span class="comment">// Use the `Unaligned` bound on `Packet` to prove that it's okay to
// return concurrent references to `packet` and `rest`.
</span><span class="kw">let </span>(packet, rest) = split.via_unaligned();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
<span class="macro">assert_eq!</span>(rest, [<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
rest.fill(<span class="number">0</span>);
}
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.via_runtime_check-1" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#654-659">Source</a><h4 class="code-header">pub fn <a href="#method.via_runtime_check-1" class="fn">via_runtime_check</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a mut T</a>, &amp;'a mut [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>]), Self&gt;</h4></section></summary><div class="docblock"><p>Produces the split parts of <code>self</code>, using a dynamic check to ensure that
it is sound to have concurrent references to both parts. You should
prefer using <a href="struct.Split.html#method.via_into_bytes" title="method zerocopy::Split::via_into_bytes"><code>Self::via_into_bytes</code></a> or <a href="struct.Split.html#method.via_unaligned" title="method zerocopy::Split::via_unaligned"><code>Self::via_unaligned</code></a>, which
have no runtime cost.</p>
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerocopy::{SplitAt, FromBytes};
<span class="attr">#[derive(SplitAt, FromBytes, KnownLayout, IntoBytes, Debug)]
#[repr(C)]
</span><span class="kw">struct </span>Packet&lt;B: <span class="question-mark">?</span>Sized&gt; {
length: u8,
body: B,
}
<span class="comment">// These bytes encode a `Packet`.
</span><span class="kw">let </span><span class="kw-2">mut </span>bytes = <span class="kw-2">&amp;mut </span>[<span class="number">4</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>][..];
<span class="kw">let </span>packet = Packet::&lt;[u8]&gt;::mut_from_bytes(bytes).unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
{
<span class="comment">// Attempt to split `packet` at `length`.
</span><span class="kw">let </span>split = packet.split_at_mut(packet.length <span class="kw">as </span>usize).unwrap();
<span class="comment">// Use a dynamic check to prove that it's okay to return concurrent
// references to `packet` and `rest`.
</span><span class="kw">let </span>(packet, rest) = split.via_runtime_check().unwrap();
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
<span class="macro">assert_eq!</span>(rest, [<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]);
rest.fill(<span class="number">0</span>);
}
<span class="macro">assert_eq!</span>(packet.length, <span class="number">4</span>);
<span class="macro">assert_eq!</span>(packet.body, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.via_unchecked-1" class="method"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#672-678">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.via_unchecked-1" class="fn">via_unchecked</a>(self) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;'a mut T</a>, &amp;'a mut [T::<a class="associatedtype" href="trait.SplitAt.html#associatedtype.Elem" title="type zerocopy::SplitAt::Elem">Elem</a>])</h4></section></summary><div class="docblock"><p>Unsafely produces the split parts of <code>self</code>.</p>
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
<p>The trailing padding bytes of the left portion must not overlap the
right portion. For some dynamically sized types, the padding that
appears after the trailing slice field <a href="trait.KnownLayout.html#slice-dst-layout" title="trait zerocopy::KnownLayout">is a dynamic function of the
trailing slice length</a>. Thus, for some
types, this condition is dependent on the length of the left portion.</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-Debug-for-Split%3CT%3E" class="impl"><a class="src rightside" href="../src/zerocopy/split_at.rs.html#231">Source</a><a href="#impl-Debug-for-Split%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <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.Split.html" title="struct zerocopy::Split">Split</a>&lt;T&gt;</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/split_at.rs.html#231">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.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;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>&lt;'_&gt;) -&gt; <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></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-Split%3CT%3E" class="impl"><a href="#impl-Freeze-for-Split%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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.Split.html" title="struct zerocopy::Split">Split</a>&lt;T&gt;<div class="where">where
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>,</div></h3></section><section id="impl-RefUnwindSafe-for-Split%3CT%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Split%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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.Split.html" title="struct zerocopy::Split">Split</a>&lt;T&gt;<div class="where">where
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>,</div></h3></section><section id="impl-Send-for-Split%3CT%3E" class="impl"><a href="#impl-Send-for-Split%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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.Split.html" title="struct zerocopy::Split">Split</a>&lt;T&gt;<div class="where">where
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>,</div></h3></section><section id="impl-Sync-for-Split%3CT%3E" class="impl"><a href="#impl-Sync-for-Split%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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.Split.html" title="struct zerocopy::Split">Split</a>&lt;T&gt;<div class="where">where
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>,</div></h3></section><section id="impl-Unpin-for-Split%3CT%3E" class="impl"><a href="#impl-Unpin-for-Split%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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.Split.html" title="struct zerocopy::Split">Split</a>&lt;T&gt;<div class="where">where
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>,</div></h3></section><section id="impl-UnwindSafe-for-Split%3CT%3E" class="impl"><a href="#impl-UnwindSafe-for-Split%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <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.Split.html" title="struct zerocopy::Split">Split</a>&lt;T&gt;<div class="where">where
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>,</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&lt;T&gt; <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>(&amp;self) -&gt; <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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; 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>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; 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>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&amp;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-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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; 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) -&gt; 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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; 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>&lt;T&gt;,</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) -&gt; 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>&lt;T&gt; for U</code> chooses to do.</p>
</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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; 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>&lt;T&gt;,</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) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;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>&lt;U&gt;&gt;::<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>&gt;</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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; 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>&lt;T&gt;,</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> = &lt;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>&lt;T&gt;&gt;::<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) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;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>&lt;T&gt;&gt;::<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>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink