11 lines
10 KiB
HTML
11 lines
10 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="Traits over unaligned little-endian data (ULE, pronounced “yule”)."><title>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 mod"><!--[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="#">Module 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="#">Module ule</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#unions" title="Unions">Unions</a></li><li><a href="#derives" title="Derive Macros">Derive Macros</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate zerovec</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></div><h1>Module <span>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#5-452">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Traits over unaligned little-endian data (ULE, pronounced “yule”).</p>
|
|
<p>The main traits for this module are <a href="trait.ULE.html" title="trait zerovec::ule::ULE"><code>ULE</code></a>, <a href="trait.AsULE.html" title="trait zerovec::ule::AsULE"><code>AsULE</code></a> and, <a href="trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a>.</p>
|
|
<p>See <a href="https://github.com/unicode-org/icu4x/blob/main/utils/zerovec/design_doc.md">the design doc</a> for details on how these traits
|
|
works under the hood.</p>
|
|
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="custom/index.html" title="mod zerovec::ule::custom">custom</a></dt><dd>Documentation on implementing custom VarULE types.</dd><dt><a class="mod" href="tuple/index.html" title="mod zerovec::ule::tuple">tuple</a></dt><dd>ULE impls for tuples.</dd><dt><a class="mod" href="tuplevar/index.html" title="mod zerovec::ule::tuplevar">tuplevar</a></dt><dd><a href="trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a> impls for tuples.</dd><dt><a class="mod" href="vartuple/index.html" title="mod zerovec::ule::vartuple">vartuple</a></dt><dd>Types to help compose fixed-size <a href="trait.ULE.html" title="trait zerovec::ule::ULE"><code>ULE</code></a> and variable-size <a href="trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a> primitives.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CharULE.html" title="struct zerovec::ule::CharULE">CharULE</a></dt><dd>A u8 array of little-endian data corresponding to a Unicode scalar value.</dd><dt><a class="struct" href="struct.MultiFieldsULE.html" title="struct zerovec::ule::MultiFieldsULE">Multi<wbr>FieldsULE</a></dt><dd>This type is used by the custom derive to represent multiple <a href="trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a>
|
|
fields packed into a single end-of-struct field. It is not recommended
|
|
to use this type directly, use <a href="tuplevar/struct.Tuple2VarULE.html" title="struct zerovec::ule::tuplevar::Tuple2VarULE"><code>Tuple2VarULE</code></a> etc instead.</dd><dt><a class="struct" href="struct.NichedOption.html" title="struct zerovec::ule::NichedOption">Niched<wbr>Option</a></dt><dd>Optional type which uses <a href="union.NichedOptionULE.html" title="union zerovec::ule::NichedOptionULE"><code>NichedOptionULE<U,N></code></a> as ULE type.</dd><dt><a class="struct" href="struct.OptionULE.html" title="struct zerovec::ule::OptionULE">OptionULE</a></dt><dd>This type is the <a href="trait.ULE.html" title="trait zerovec::ule::ULE"><code>ULE</code></a> type for <code>Option<U></code> where <code>U</code> is a <a href="trait.ULE.html" title="trait zerovec::ule::ULE"><code>ULE</code></a> type</dd><dt><a class="struct" href="struct.OptionVarULE.html" title="struct zerovec::ule::OptionVarULE">Option<wbr>VarULE</a></dt><dd>A type allowing one to represent <code>Option<U></code> for <a href="trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a> <code>U</code> types.</dd><dt><a class="struct" href="struct.RawBytesULE.html" title="struct zerovec::ule::RawBytesULE">RawBytesULE</a></dt><dd>A u8 array of little-endian data with infallible conversions to and from &<a href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html" title="primitive u8">u8</a>.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.UleError.html" title="enum zerovec::ule::UleError">UleError</a></dt><dd>An error type to be used for decoding slices of ULE types</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.AsULE.html" title="trait zerovec::ule::AsULE">AsULE</a></dt><dd>A trait for any type that has a 1:1 mapping with an unaligned little-endian (ULE) type.</dd><dt><a class="trait" href="trait.EncodeAsVarULE.html" title="trait zerovec::ule::EncodeAsVarULE">Encode<wbr>AsVarULE</a></dt><dd>Allows types to be encoded as VarULEs. This is highly useful for implementing VarULE on
|
|
custom DSTs where the type cannot be obtained as a reference to some other type.</dd><dt><a class="trait" href="trait.EqULE.html" title="trait zerovec::ule::EqULE">EqULE</a></dt><dd>A type whose byte sequence equals the byte sequence of its ULE type on
|
|
little-endian platforms.</dd><dt><a class="trait" href="trait.NicheBytes.html" title="trait zerovec::ule::NicheBytes">Niche<wbr>Bytes</a></dt><dd>The <a href="trait.ULE.html" title="trait zerovec::ule::ULE"><code>ULE</code></a> types implementing this trait guarantee that <a href="trait.NicheBytes.html#associatedconstant.NICHE_BIT_PATTERN" title="associated constant zerovec::ule::NicheBytes::NICHE_BIT_PATTERN"><code>NicheBytes::NICHE_BIT_PATTERN</code></a>
|
|
can never occur as a valid byte representation of the type.</dd><dt><a class="trait" href="trait.SliceAsULE.html" title="trait zerovec::ule::SliceAsULE">Slice<wbr>AsULE</a></dt><dd>A trait for a type where aligned slices can be cast to unaligned slices.</dd><dt><a class="trait" href="trait.ULE.html" title="trait zerovec::ule::ULE">ULE</a></dt><dd>Fixed-width, byte-aligned data that can be cast to and from a little-endian byte slice.</dd><dt><a class="trait" href="trait.VarULE.html" title="trait zerovec::ule::VarULE">VarULE</a></dt><dd>Variable-width, byte-aligned data that can be cast to and from a little-endian byte slice.</dd></dl><h2 id="unions" class="section-header">Unions<a href="#unions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="union" href="union.NichedOptionULE.html" title="union zerovec::ule::NichedOptionULE">Niched<wbr>OptionULE</a></dt><dd><a href="trait.ULE.html" title="trait zerovec::ule::ULE"><code>ULE</code></a> type for <a href="struct.NichedOption.html" title="struct zerovec::ule::NichedOption"><code>NichedOption<U,N></code></a> where U implements <a href="trait.NicheBytes.html" title="trait zerovec::ule::NicheBytes"><code>NicheBytes</code></a>.
|
|
The invalid bit pattern is used as the niche.</dd></dl><h2 id="derives" class="section-header">Derive Macros<a href="#derives" class="anchor">§</a></h2><dl class="item-table"><dt><a class="derive" href="derive.ULE.html" title="derive zerovec::ule::ULE">ULE</a></dt><dd>Custom derive for <a href="trait.ULE.html" title="trait zerovec::ule::ULE"><code>ULE</code></a>.</dd><dt><a class="derive" href="derive.VarULE.html" title="derive zerovec::ule::VarULE">VarULE</a></dt><dd>Custom derive for <a href="trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a></dd></dl></section></div></main></body></html> |