mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-17 00:13:48 +00:00
23 lines
No EOL
12 KiB
HTML
23 lines
No EOL
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A mutable or immutable reference to a byte slice."><title>ByteSlice in zerocopy - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../zerocopy/index.html">zerocopy</a><span class="version">0.7.35</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Byte<wbr>Slice</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.split_at" title="split_at">split_at</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.as_ptr" title="as_ptr">as_ptr</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ByteSlice-for-%26%5Bu8%5D" title="&'a [u8]">&'a [u8]</a></li><li><a href="#impl-ByteSlice-for-%26mut+%5Bu8%5D" title="&'a mut [u8]">&'a mut [u8]</a></li><li><a href="#impl-ByteSlice-for-Ref%3C'a,+%5Bu8%5D%3E" title="Ref<'a, [u8]>">Ref<'a, [u8]></a></li><li><a href="#impl-ByteSlice-for-RefMut%3C'a,+%5Bu8%5D%3E" title="RefMut<'a, [u8]>">RefMut<'a, [u8]></a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate zerocopy</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">zerocopy</a></span><h1>Trait <span class="trait">ByteSlice</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/lib.rs.html#5150-5188">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait ByteSlice:
|
|
<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.u8.html">u8</a>]>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>
|
|
+ ByteSliceSealed {
|
|
// Required method
|
|
fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.usize.html">usize</a>) -> (Self, Self);
|
|
|
|
// Provided method
|
|
fn <a href="#method.as_ptr" class="fn">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.pointer.html">*const </a><a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.u8.html">u8</a> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A mutable or immutable reference to a byte slice.</p>
|
|
<p><code>ByteSlice</code> abstracts over the mutability of a byte slice reference, and is
|
|
implemented for various special reference types such as <code>Ref<[u8]></code> and
|
|
<code>RefMut<[u8]></code>.</p>
|
|
<p>Note that, while it would be technically possible, <code>ByteSlice</code> is not
|
|
implemented for <a href="https://doc.rust-lang.org/std/vec/struct.Vec.html"><code>Vec<u8></code></a>, as the only way to implement the <a href="trait.ByteSlice.html#tymethod.split_at" title="method zerocopy::ByteSlice::split_at"><code>split_at</code></a>
|
|
method would involve reallocation, and <code>split_at</code> must be a very cheap
|
|
operation in order for the utilities in this crate to perform as designed.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.split_at" class="method"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5187">Source</a><h4 class="code-header">fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.usize.html">usize</a>) -> (Self, Self)</h4></section></summary><div class="docblock"><p>Splits the slice at the midpoint.</p>
|
|
<p><code>x.split_at(mid)</code> returns <code>x[..mid]</code> and <code>x[mid..]</code>.</p>
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|
<p><code>x.split_at(mid)</code> panics if <code>mid > x.len()</code>.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.as_ptr" class="method"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5176-5178">Source</a><h4 class="code-header">fn <a href="#method.as_ptr" class="fn">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.pointer.html">*const </a><a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.u8.html">u8</a></h4></section></summary><div class="docblock"><p>Gets a raw pointer to the first byte in the slice.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.1/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ByteSlice-for-%26%5Bu8%5D" class="impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5207-5216">Source</a><a href="#impl-ByteSlice-for-%26%5Bu8%5D" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::ByteSlice">ByteSlice</a> for &'a [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.u8.html">u8</a>]</h3></section></summary><div class="impl-items"><section id="method.split_at" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5213-5215">Source</a><a href="#method.split_at" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.usize.html">usize</a>) -> (Self, Self)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ByteSlice-for-%26mut+%5Bu8%5D" class="impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5221-5230">Source</a><a href="#impl-ByteSlice-for-%26mut+%5Bu8%5D" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::ByteSlice">ByteSlice</a> for &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.u8.html">u8</a>]</h3></section></summary><div class="impl-items"><section id="method.split_at-1" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5227-5229">Source</a><a href="#method.split_at-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.usize.html">usize</a>) -> (Self, Self)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ByteSlice-for-Ref%3C'a,+%5Bu8%5D%3E" class="impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5235-5250">Source</a><a href="#impl-ByteSlice-for-Ref%3C'a,+%5Bu8%5D%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::ByteSlice">ByteSlice</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><'a, [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.u8.html">u8</a>]></h3></section></summary><div class="impl-items"><section id="method.split_at-2" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5247-5249">Source</a><a href="#method.split_at-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.usize.html">usize</a>) -> (Self, Self)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ByteSlice-for-RefMut%3C'a,+%5Bu8%5D%3E" class="impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5255-5270">Source</a><a href="#impl-ByteSlice-for-RefMut%3C'a,+%5Bu8%5D%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.ByteSlice.html" title="trait zerocopy::ByteSlice">ByteSlice</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/cell/struct.RefMut.html" title="struct core::cell::RefMut">RefMut</a><'a, [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.u8.html">u8</a>]></h3></section></summary><div class="impl-items"><section id="method.split_at-3" class="method trait-impl"><a class="src rightside" href="../src/zerocopy/lib.rs.html#5267-5269">Source</a><a href="#method.split_at-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/core/primitive.usize.html">usize</a>) -> (Self, Self)</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/zerocopy/trait.ByteSlice.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |