33 lines
8.6 KiB
HTML
33 lines
8.6 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 necessary functionality for highly efficient querying of sets of Unicode characters."><title>icu_collections::codepointinvlist - 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 codepointinvlist</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 codepointinvlist</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="#creating-a-codepointinversionlist" title="Creating a `CodePointInversionList`">Creating a <code>CodePointInversionList</code></a></li><li><a href="#querying-a-codepointinversionlist" title="Querying a `CodePointInversionList`">Querying a <code>CodePointInversionList</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></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>codepointinvlist</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/codepointinvlist/mod.rs.html#5-80">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 necessary functionality for highly efficient querying of sets of Unicode characters.</p>
|
|
<p>It is an implementation of the code point portion of the existing
|
|
<a href="https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1UnicodeSet.html">ICU4C UnicodeSet API</a>.</p>
|
|
<h2 id="architecture"><a class="doc-anchor" href="#architecture">§</a>Architecture</h2>
|
|
<p>ICU4X <a href="struct.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList"><code>CodePointInversionList</code></a> is split up into independent levels, with <a href="struct.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList"><code>CodePointInversionList</code></a> representing the membership/query API,
|
|
and [<code>CodePointInversionListBuilder</code>] representing the builder API.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples:</h2><h3 id="creating-a-codepointinversionlist"><a class="doc-anchor" href="#creating-a-codepointinversionlist">§</a>Creating a <code>CodePointInversionList</code></h3>
|
|
<p><code>CodePointSets</code> are created from either serialized <a href="struct.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList"><code>CodePointSets</code></a>,
|
|
represented by <a href="http://userguide.icu-project.org/strings/properties">inversion lists</a>,
|
|
the [<code>CodePointInversionListBuilder</code>], or from the Properties API.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>icu::collections::codepointinvlist::{
|
|
CodePointInversionList, CodePointInversionListBuilder,
|
|
};
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>builder = CodePointInversionListBuilder::new();
|
|
builder.add_range(<span class="string">'A'</span>..=<span class="string">'Z'</span>);
|
|
<span class="kw">let </span>set: CodePointInversionList = builder.build();
|
|
|
|
<span class="macro">assert!</span>(set.contains(<span class="string">'A'</span>));</code></pre></div><h3 id="querying-a-codepointinversionlist"><a class="doc-anchor" href="#querying-a-codepointinversionlist">§</a>Querying a <code>CodePointInversionList</code></h3>
|
|
<p>Currently, you can check if a character/range of characters exists in the <a href="struct.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList"><code>CodePointInversionList</code></a>, or iterate through the characters.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>icu::collections::codepointinvlist::{
|
|
CodePointInversionList, CodePointInversionListBuilder,
|
|
};
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>builder = CodePointInversionListBuilder::new();
|
|
builder.add_range(<span class="string">'A'</span>..=<span class="string">'Z'</span>);
|
|
<span class="kw">let </span>set: CodePointInversionList = builder.build();
|
|
|
|
<span class="macro">assert!</span>(set.contains(<span class="string">'A'</span>));
|
|
<span class="macro">assert!</span>(set.contains_range(<span class="string">'A'</span>..=<span class="string">'C'</span>));
|
|
<span class="macro">assert_eq!</span>(set.iter_chars().next(), <span class="prelude-val">Some</span>(<span class="string">'A'</span>));</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.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList">Code<wbr>Point<wbr>Inversion<wbr>List</a></dt><dd>A membership wrapper for <a href="struct.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList"><code>CodePointInversionList</code></a>.</dd><dt><a class="struct" href="struct.CodePointInversionListULE.html" title="struct icu_collections::codepointinvlist::CodePointInversionListULE">Code<wbr>Point<wbr>Inversion<wbr>ListULE</a></dt><dd><a href="../../zerovec/ule/trait.VarULE.html" title="trait zerovec::ule::VarULE"><code>VarULE</code></a> type for <a href="struct.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList"><code>CodePointInversionList</code></a>. See <a href="struct.CodePointInversionList.html" title="struct icu_collections::codepointinvlist::CodePointInversionList"><code>CodePointInversionList</code></a> for documentation.</dd><dt><a class="struct" href="struct.InvalidSetError.html" title="struct icu_collections::codepointinvlist::InvalidSetError">Invalid<wbr>SetError</a></dt><dd>A CodePointInversionList was constructed with an invalid inversion list</dd><dt><a class="struct" href="struct.RangeError.html" title="struct icu_collections::codepointinvlist::RangeError">Range<wbr>Error</a></dt><dd>A CodePointInversionList was constructed from an invalid range</dd></dl></section></div></main></body></html> |