25 lines
7.5 KiB
HTML
25 lines
7.5 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="The ucd-trie crate provides a compressed trie set specifically tailored for Unicode codepoints. The principle use case for such a trie is to represent properties defined by Unicode that correspond to sets of Unicode codepoints. (These properties are formally called boolean properties or “single valued” properties. See UTR#23 S3.3 for more details.)"><meta name="keywords" content="rust, rustlang, rust-lang, ucd_trie"><title>ucd_trie - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[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">☰</button><a class="sidebar-logo" href="../ucd_trie/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../ucd_trie/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate ucd_trie</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.5</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../ucd_trie/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">ucd_trie</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/ucd_trie/lib.rs.html#1-117">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The ucd-trie crate provides a compressed trie set specifically tailored for
|
||
Unicode codepoints. The principle use case for such a trie is to represent
|
||
properties defined by Unicode that correspond to sets of Unicode codepoints.
|
||
(These properties are formally called boolean properties or “single valued”
|
||
properties. See
|
||
<a href="https://www.unicode.org/reports/tr23/#PropertyTypeDefinitions">UTR#23 S3.3</a>
|
||
for more details.)</p>
|
||
<p>This crate has two principle types: <code>TrieSetOwned</code> and <code>TrieSetSlice</code>,
|
||
corresponding to a similar split as there is between <code>Vec<T></code> and <code>&[T]</code>.
|
||
<code>TrieSetOwned</code> is the only way to construct a trie from a set of Unicode
|
||
codepoints.</p>
|
||
<p>The intended use of this library is to embed a static instance of
|
||
<code>TrieSetSlice</code> into your source code, and then use its methods as defined in
|
||
this crate to test membership. (The <code>ucd-generate</code> tool can likely generate
|
||
this code for you.)</p>
|
||
<p>Finally, while this crate uses the standard library by default, it provides
|
||
<code>no_std</code> functionality by disabling the <code>std</code> feature. When <code>no_std</code> is
|
||
enabled, then <code>TrieSetOwned</code> is not provided. Instead, only <code>TrieSetSlice</code> is
|
||
provided, which means <code>no_std</code> crates can still embed tries into their code.</p>
|
||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TrieSetOwned.html" title="ucd_trie::TrieSetOwned struct">TrieSetOwned</a></div><div class="item-right docblock-short"><p>An owned trie set.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TrieSetSlice.html" title="ucd_trie::TrieSetSlice struct">TrieSetSlice</a></div><div class="item-right docblock-short"><p>A borrowed trie set.</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="ucd_trie::Error enum">Error</a></div><div class="item-right docblock-short"><p>An error that can occur during construction of a trie.</p>
|
||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Result.html" title="ucd_trie::Result type">Result</a></div><div class="item-right docblock-short"><p>A type alias that maps to <code>std::result::Result<T, ucd_trie::Error></code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.TrieSet.html" title="ucd_trie::TrieSet type">TrieSet</a></div><div class="item-right docblock-short"><p>A type alias for <code>TrieSetSlice<'static></code>.</p>
|
||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="ucd_trie" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |