88 lines
31 KiB
HTML
88 lines
31 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="Fixed-width, byte-aligned data that can be cast to and from a little-endian byte slice."><title>ULE in zerovec::ule - 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="zerovec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">ULE</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../zerovec/index.html">zerovec</a><span class="version">0.11.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">ULE</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li><li><a href="#equality-invariant" title="Equality invariant">Equality invariant</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.validate_bytes" title="validate_bytes">validate_bytes</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.parse_bytes_to_slice" title="parse_bytes_to_slice">parse_bytes_to_slice</a></li><li><a href="#method.slice_as_bytes" title="slice_as_bytes">slice_as_bytes</a></li><li><a href="#method.slice_from_bytes_unchecked" title="slice_from_bytes_unchecked">slice_from_bytes_unchecked</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ULE-for-()" title="()">()</a></li><li><a href="#impl-ULE-for-NonZero%3Cu8%3E" title="NonZeroU8">NonZeroU8</a></li><li><a href="#impl-ULE-for-%5BT;+N%5D" title="[T; N]">[T; N]</a></li><li><a href="#impl-ULE-for-bool" title="bool">bool</a></li><li><a href="#impl-ULE-for-i8" title="i8">i8</a></li><li><a href="#impl-ULE-for-u8" title="u8">u8</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In zerovec::<wbr>ule</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">zerovec</a>::<wbr><a href="index.html">ule</a></div><h1>Trait <span class="trait">ULE</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/zerovec/ule/mod.rs.html#79-155">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait ULE<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> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + 'static,</div>{
|
|
// Required method
|
|
fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.parse_bytes_to_slice" class="fn">parse_bytes_to_slice</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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><&[Self], <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>> { ... }
|
|
<span class="item-spacer"></span> unsafe fn <a href="#method.slice_from_bytes_unchecked" class="fn">slice_from_bytes_unchecked</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> &[Self] { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.slice_as_bytes" class="fn">slice_as_bytes</a>(slice: &[Self]) -> &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>] <a href="#" class="tooltip" data-notable-ty="&[u8]">ⓘ</a> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Fixed-width, byte-aligned data that can be cast to and from a little-endian byte slice.</p>
|
|
<p>If you need to implement this trait, consider using <a href="../attr.make_ule.html" title="attr zerovec::make_ule"><code>#[make_ule]</code></a> or
|
|
<a href="derive.ULE.html" title="derive zerovec::ule::ULE"><code>#[derive(ULE)]</code></a> instead.</p>
|
|
<p>Types that are not fixed-width can implement <a href="trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a> instead.</p>
|
|
<p>“ULE” stands for “Unaligned little-endian”</p>
|
|
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
|
<p>Safety checklist for <code>ULE</code>:</p>
|
|
<ol>
|
|
<li>The type <em>must not</em> include any uninitialized or padding bytes.</li>
|
|
<li>The type must have an alignment of 1 byte, or it is a ZST that is safe to construct.</li>
|
|
<li>The impl of <a href="trait.ULE.html#tymethod.validate_bytes" title="associated function zerovec::ule::ULE::validate_bytes"><code>ULE::validate_bytes()</code></a> <em>must</em> return an error if the given byte slice
|
|
would not represent a valid slice of this type.</li>
|
|
<li>The impl of <a href="trait.ULE.html#tymethod.validate_bytes" title="associated function zerovec::ule::ULE::validate_bytes"><code>ULE::validate_bytes()</code></a> <em>must</em> return an error if the given byte slice
|
|
cannot be used in its entirety (if its length is not a multiple of <code>size_of::<Self>()</code>).</li>
|
|
<li>All other methods <em>must</em> be left with their default impl, or else implemented according to
|
|
their respective safety guidelines.</li>
|
|
<li>Acknowledge the following note about the equality invariant.</li>
|
|
</ol>
|
|
<p>If the ULE type is a struct only containing other ULE types (or other types which satisfy invariants 1 and 2,
|
|
like <code>[u8; N]</code>), invariants 1 and 2 can be achieved via <code>#[repr(C, packed)]</code> or <code>#[repr(transparent)]</code>.</p>
|
|
<h2 id="equality-invariant"><a class="doc-anchor" href="#equality-invariant">§</a>Equality invariant</h2>
|
|
<p>A non-safety invariant is that if <code>Self</code> implements <code>PartialEq</code>, the it <em>must</em> be logically
|
|
equivalent to byte equality on <a href="trait.ULE.html#method.slice_as_bytes"><code>Self::slice_as_bytes()</code></a>.</p>
|
|
<p>It may be necessary to introduce a “canonical form” of the ULE if logical equality does not
|
|
equal byte equality. In such a case, <a href="trait.ULE.html#tymethod.validate_bytes" title="associated function zerovec::ule::ULE::validate_bytes"><code>Self::validate_bytes()</code></a> should return an error
|
|
for any values that are not in canonical form. For example, the decimal strings “1.23e4” and
|
|
“12.3e3” are logically equal, but not byte-for-byte equal, so we could define a canonical form
|
|
where only a single digit is allowed before <code>.</code>.</p>
|
|
<p>Failure to follow this invariant will cause surprising behavior in <code>PartialEq</code>, which may
|
|
result in unpredictable operations on <code>ZeroVec</code>, <code>VarZeroVec</code>, and <code>ZeroMap</code>.</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.validate_bytes" class="method"><a class="src rightside" href="../../src/zerovec/ule/mod.rs.html#89">Source</a><h4 class="code-header">fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></summary><div class="docblock"><p>Validates a byte slice, <code>&[u8]</code>.</p>
|
|
<p>If <code>Self</code> is not well-defined for all possible bit values, the bytes should be validated.
|
|
If the bytes can be transmuted, <em>in their entirety</em>, to a valid slice of <code>Self</code>, then <code>Ok</code>
|
|
should be returned; otherwise, <code>Err</code> should be returned.</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.parse_bytes_to_slice" class="method"><a class="src rightside" href="../../src/zerovec/ule/mod.rs.html#101-105">Source</a><h4 class="code-header">fn <a href="#method.parse_bytes_to_slice" class="fn">parse_bytes_to_slice</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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><&[Self], <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></summary><div class="docblock"><p>Parses a byte slice, <code>&[u8]</code>, and return it as <code>&[Self]</code> with the same lifetime.</p>
|
|
<p>If <code>Self</code> is not well-defined for all possible bit values, the bytes should be validated,
|
|
and an error should be returned in the same cases as <a href="trait.ULE.html#tymethod.validate_bytes"><code>Self::validate_bytes()</code></a>.</p>
|
|
<p>The default implementation executes <a href="trait.ULE.html#tymethod.validate_bytes"><code>Self::validate_bytes()</code></a> followed by
|
|
<a href="trait.ULE.html#method.slice_from_bytes_unchecked"><code>Self::slice_from_bytes_unchecked</code></a>.</p>
|
|
<p>Note: The following equality should hold: <code>bytes.len() % size_of::<Self>() == 0</code>. This
|
|
means that the returned slice can span the entire byte slice.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.slice_from_bytes_unchecked" class="method"><a class="src rightside" href="../../src/zerovec/ule/mod.rs.html#132-137">Source</a><h4 class="code-header">unsafe fn <a href="#method.slice_from_bytes_unchecked" class="fn">slice_from_bytes_unchecked</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> &[Self]</h4></section></summary><div class="docblock"><p>Takes a byte slice, <code>&[u8]</code>, and return it as <code>&[Self]</code> with the same lifetime, assuming
|
|
that this byte slice has previously been run through <a href="trait.ULE.html#method.parse_bytes_to_slice"><code>Self::parse_bytes_to_slice()</code></a> with
|
|
success.</p>
|
|
<p>The default implementation performs a pointer cast to the same region of memory.</p>
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5><h6 id="callers"><a class="doc-anchor" href="#callers">§</a>Callers</h6>
|
|
<p>Callers of this method must take care to ensure that <code>bytes</code> was previously passed through
|
|
<a href="trait.ULE.html#tymethod.validate_bytes"><code>Self::validate_bytes()</code></a> with success (and was not changed since then).</p>
|
|
<h6 id="implementors-1"><a class="doc-anchor" href="#implementors-1">§</a>Implementors</h6>
|
|
<p>Implementations of this method may call unsafe functions to cast the pointer to the correct
|
|
type, assuming the “Callers” invariant above.</p>
|
|
<p>Keep in mind that <code>&[Self]</code> and <code>&[u8]</code> may have different lengths.</p>
|
|
<p>Safety checklist:</p>
|
|
<ol>
|
|
<li>This method <em>must</em> return the same result as <a href="trait.ULE.html#method.parse_bytes_to_slice"><code>Self::parse_bytes_to_slice()</code></a>.</li>
|
|
<li>This method <em>must</em> return a slice to the same region of memory as the argument.</li>
|
|
</ol>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.slice_as_bytes" class="method"><a class="src rightside" href="../../src/zerovec/ule/mod.rs.html#150-154">Source</a><h4 class="code-header">fn <a href="#method.slice_as_bytes" class="fn">slice_as_bytes</a>(slice: &[Self]) -> &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>] <a href="#" class="tooltip" data-notable-ty="&[u8]">ⓘ</a></h4></section></summary><div class="docblock"><p>Given <code>&[Self]</code>, returns a <code>&[u8]</code> with the same lifetime.</p>
|
|
<p>The default implementation performs a pointer cast to the same region of memory.</p>
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
|
|
<p>Implementations of this method should call potentially unsafe functions to cast the
|
|
pointer to the correct type.</p>
|
|
<p>Keep in mind that <code>&[Self]</code> and <code>&[u8]</code> may have different lengths.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ULE-for-bool" class="impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#339-351">Source</a><a href="#impl-ULE-for-bool" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h3></section></summary><div class="impl-items"><section id="method.validate_bytes" class="method trait-impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#341-350">Source</a><a href="#method.validate_bytes" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ULE-for-i8" class="impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#256-261">Source</a><a href="#impl-ULE-for-i8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="method.validate_bytes-1" class="method trait-impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#258-260">Source</a><a href="#method.validate_bytes-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(_bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ULE-for-u8" class="impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#189-194">Source</a><a href="#impl-ULE-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.validate_bytes-2" class="method trait-impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#191-193">Source</a><a href="#method.validate_bytes-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(_bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ULE-for-()" class="impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#375-384">Source</a><a href="#impl-ULE-for-()" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a></h3></section></summary><div class="impl-items"><section id="method.validate_bytes-3" class="method trait-impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#377-383">Source</a><a href="#method.validate_bytes-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ULE-for-NonZero%3Cu8%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#218-229">Source</a><a href="#impl-ULE-for-NonZero%3Cu8%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="type" href="https://doc.rust-lang.org/1.93.1/core/num/nonzero/type.NonZeroU8.html" title="type core::num::nonzero::NonZeroU8">NonZeroU8</a></h3></section></summary><div class="impl-items"><section id="method.validate_bytes-4" class="method trait-impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#220-228">Source</a><a href="#method.validate_bytes-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ULE-for-%5BT;+N%5D" class="impl"><a class="src rightside" href="../../src/zerovec/ule/slices.rs.html#14-20">Source</a><a href="#impl-ULE-for-%5BT;+N%5D" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, const N: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.array.html">[T; N]</a></h3></section></summary><div class="impl-items"><section id="method.validate_bytes-5" class="method trait-impl"><a class="src rightside" href="../../src/zerovec/ule/slices.rs.html#16-19">Source</a><a href="#method.validate_bytes-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.validate_bytes" class="fn">validate_bytes</a>(bytes: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, <a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ULE-for-CharULE" class="impl"><a class="src rightside" href="../../src/zerovec/ule/chars.rs.html#78-94">Source</a><a href="#impl-ULE-for-CharULE" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="struct.CharULE.html" title="struct zerovec::ule::CharULE">CharULE</a></h3></section><section id="impl-ULE-for-Tuple2ULE%3CA,+B%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/tuple.rs.html#130">Source</a><a href="#impl-ULE-for-Tuple2ULE%3CA,+B%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, B: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="tuple/struct.Tuple2ULE.html" title="struct zerovec::ule::tuple::Tuple2ULE">Tuple2ULE</a><A, B></h3></section><section id="impl-ULE-for-Tuple3ULE%3CA,+B,+C%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/tuple.rs.html#131">Source</a><a href="#impl-ULE-for-Tuple3ULE%3CA,+B,+C%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, B: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, C: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="tuple/struct.Tuple3ULE.html" title="struct zerovec::ule::tuple::Tuple3ULE">Tuple3ULE</a><A, B, C></h3></section><section id="impl-ULE-for-Tuple4ULE%3CA,+B,+C,+D%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/tuple.rs.html#132">Source</a><a href="#impl-ULE-for-Tuple4ULE%3CA,+B,+C,+D%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, B: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, C: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, D: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="tuple/struct.Tuple4ULE.html" title="struct zerovec::ule::tuple::Tuple4ULE">Tuple4ULE</a><A, B, C, D></h3></section><section id="impl-ULE-for-Tuple5ULE%3CA,+B,+C,+D,+E%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/tuple.rs.html#133">Source</a><a href="#impl-ULE-for-Tuple5ULE%3CA,+B,+C,+D,+E%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, B: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, C: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, D: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, E: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="tuple/struct.Tuple5ULE.html" title="struct zerovec::ule::tuple::Tuple5ULE">Tuple5ULE</a><A, B, C, D, E></h3></section><section id="impl-ULE-for-Tuple6ULE%3CA,+B,+C,+D,+E,+F%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/tuple.rs.html#134">Source</a><a href="#impl-ULE-for-Tuple6ULE%3CA,+B,+C,+D,+E,+F%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, B: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, C: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, D: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, E: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, F: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="tuple/struct.Tuple6ULE.html" title="struct zerovec::ule::tuple::Tuple6ULE">Tuple6ULE</a><A, B, C, D, E, F></h3></section><section id="impl-ULE-for-NichedOptionULE%3CU,+N%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/niche.rs.html#134-155">Source</a><a href="#impl-ULE-for-NichedOptionULE%3CU,+N%3E" class="anchor">§</a><h3 class="code-header">impl<U: <a class="trait" href="trait.NicheBytes.html" title="trait zerovec::ule::NicheBytes">NicheBytes</a><N> + <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>, const N: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="union" href="union.NichedOptionULE.html" title="union zerovec::ule::NichedOptionULE">NichedOptionULE</a><U, N></h3><div class="docblock"><p>Safety for ULE trait</p>
|
|
</div></section><div class="docblock"><ol>
|
|
<li>NichedOptionULE does not have any padding bytes due to <code>#[repr(C)]</code> on a struct
|
|
containing only ULE fields.
|
|
NichedOptionULE either contains NICHE_BIT_PATTERN or valid U byte sequences.
|
|
In both cases the data is initialized.</li>
|
|
<li>NichedOptionULE is aligned to 1 byte due to <code>#[repr(C, packed)]</code> on a struct containing only
|
|
ULE fields.</li>
|
|
<li>validate_bytes impl returns an error if invalid bytes are encountered.</li>
|
|
<li>validate_bytes impl returns an error there are extra bytes.</li>
|
|
<li>The other ULE methods are left to their default impl.</li>
|
|
<li>NichedOptionULE equality is based on ULE equality of the subfield, assuming that NicheBytes
|
|
has been implemented correctly (this is a correctness but not a safety guarantee).</li>
|
|
</ol>
|
|
</div><section id="impl-ULE-for-OptionULE%3CU%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/option.rs.html#75-97">Source</a><a href="#impl-ULE-for-OptionULE%3CU%3E" class="anchor">§</a><h3 class="code-header">impl<U: <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="struct.OptionULE.html" title="struct zerovec::ule::OptionULE">OptionULE</a><U></h3><div class="docblock"><p>zeroed or valid-T byte sequences to fill it)</p>
|
|
</div></section><section id="impl-ULE-for-RawBytesULE%3CN%3E" class="impl"><a class="src rightside" href="../../src/zerovec/ule/plain.rs.html#43-53">Source</a><a href="#impl-ULE-for-RawBytesULE%3CN%3E" class="anchor">§</a><h3 class="code-header">impl<const N: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a> for <a class="struct" href="struct.RawBytesULE.html" title="struct zerovec::ule::RawBytesULE">RawBytesULE</a><N></h3></section></div><script src="../../trait.impl/zerovec/ule/trait.ULE.js" data-ignore-extern-crates="std,core" async></script><script type="text/json" id="notable-traits-data">{"&[u8]":"<h3>Notable traits for <code>&[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.93.1/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.93.1/std/primitive.u8.html\">u8</a>]</div>"}</script></section></div></main></body></html> |