24 lines
7.0 KiB
HTML
24 lines
7.0 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="This module provides a data structure for a space-efficient and time-efficient lookup of sequences of 16-bit units (commonly but not necessarily UTF-16 code units) which map to integer values."><title>icu_collections::char16trie - 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="icu_collections" 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 char16trie</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../icu_collections/index.html">icu_<wbr>collections</a><span class="version">2.1.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module char16trie</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#architecture" title="Architecture">Architecture</a></li><li><a href="#examples" title="Examples">Examples</a><ul><li><a href="#querying-a-char16trie" title="Querying a `Char16Trie`">Querying a <code>Char16Trie</code></a></li></ul></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate icu_<wbr>collections</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">icu_collections</a></div><h1>Module <span>char16trie</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/icu_collections/char16trie/mod.rs.html#5-44">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module provides a data structure for a space-efficient and time-efficient lookup of
|
|
sequences of 16-bit units (commonly but not necessarily UTF-16 code units)
|
|
which map to integer values.</p>
|
|
<p>It is an implementation of the existing <a href="https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1UCharsTrie.html">ICU4C UCharsTrie</a>
|
|
/ <a href="https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/CharsTrie.html">ICU4J CharsTrie</a> API.</p>
|
|
<h3 id="architecture"><a class="doc-anchor" href="#architecture">§</a>Architecture</h3>
|
|
<p>ICU4X <a href="struct.Char16Trie.html" title="struct icu_collections::char16trie::Char16Trie"><code>Char16Trie</code></a> is designed to provide a read-only view of <code>UCharsTrie</code> data that is exported from ICU4C.</p>
|
|
<h3 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h3><h4 id="querying-a-char16trie"><a class="doc-anchor" href="#querying-a-char16trie">§</a>Querying a <code>Char16Trie</code></h4>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>icu::collections::char16trie::{Char16Trie, TrieResult};
|
|
<span class="kw">use </span>zerovec::ZeroVec;
|
|
|
|
<span class="comment">// A Char16Trie containing the ASCII characters mapping 'a' to 1 and 'ab'
|
|
// to 100.
|
|
</span><span class="kw">let </span>trie_data = [<span class="number">48</span>, <span class="number">97</span>, <span class="number">176</span>, <span class="number">98</span>, <span class="number">32868</span>];
|
|
<span class="kw">let </span>trie = Char16Trie::new(ZeroVec::from_slice_or_alloc(<span class="kw-2">&</span>trie_data));
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = trie.iter();
|
|
<span class="kw">let </span>res = iter.next(<span class="string">'a'</span>);
|
|
<span class="macro">assert_eq!</span>(res, TrieResult::Intermediate(<span class="number">1</span>));
|
|
<span class="kw">let </span>res = iter.next(<span class="string">'b'</span>);
|
|
<span class="macro">assert_eq!</span>(res, TrieResult::FinalValue(<span class="number">100</span>));
|
|
<span class="kw">let </span>res = iter.next(<span class="string">'c'</span>);
|
|
<span class="macro">assert_eq!</span>(res, TrieResult::NoMatch);</code></pre></div></div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Char16Trie.html" title="struct icu_collections::char16trie::Char16Trie">Char16<wbr>Trie</a></dt><dd>This struct represents a de-serialized <code>Char16Trie</code> that was exported from
|
|
ICU binary data.</dd><dt><a class="struct" href="struct.Char16TrieIterator.html" title="struct icu_collections::char16trie::Char16TrieIterator">Char16<wbr>Trie<wbr>Iterator</a></dt><dd>This struct represents an iterator over a <a href="struct.Char16Trie.html" title="struct icu_collections::char16trie::Char16Trie"><code>Char16Trie</code></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.TrieResult.html" title="enum icu_collections::char16trie::TrieResult">Trie<wbr>Result</a></dt><dd>An enum representing the return value from a lookup in <a href="struct.Char16Trie.html" title="struct icu_collections::char16trie::Char16Trie"><code>Char16Trie</code></a>.</dd></dl></section></div></main></body></html> |