23 lines
6.9 KiB
HTML
23 lines
6.9 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="Query character Unicode properties according to Unicode Standard Annex #44 and Unicode Technical Standard #51 rules."><title>unicode_properties - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="unicode_properties" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../unicode_properties/index.html">unicode_<wbr>properties</a><span class="version">0.1.3</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#features" title="Features">Features</a><ul><li><a href="#general-category" title="`general-category`"><code>general-category</code></a></li><li><a href="#emoji" title="`emoji`"><code>emoji</code></a></li></ul></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>unicode_properties</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/unicode_properties/lib.rs.html#11-183">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Query character Unicode properties according to
|
|
<a href="https://www.unicode.org/reports/tr44/">Unicode Standard Annex #44</a>
|
|
and <a href="https://www.unicode.org/reports/tr51/">Unicode Technical Standard #51</a>
|
|
rules.</p>
|
|
<p>Currently we support the <code>General_Category</code> property as well as <code>Emoji</code> and <code>Emoji_Component</code>.</p>
|
|
<p>Future properties can be added as requested.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>unicode_properties::UnicodeEmoji;
|
|
<span class="kw">use </span>unicode_properties::UnicodeGeneralCategory;
|
|
|
|
<span class="kw">let </span>ch = <span class="string">'🦀'</span>; <span class="comment">// U+1F980 CRAB
|
|
</span><span class="kw">let </span>is_emoji = ch.is_emoji_char();
|
|
<span class="kw">let </span>group = ch.general_category_group();
|
|
<span class="macro">println!</span>(<span class="string">"{}({:?})"</span>, ch, group);
|
|
<span class="macro">println!</span>(<span class="string">"The above char {} for use as emoji char."</span>,
|
|
<span class="kw">if </span>is_emoji { <span class="string">"is recommended" </span>} <span class="kw">else </span>{ <span class="string">"is not recommended" </span>});</code></pre></div>
|
|
<h2 id="features"><a class="doc-anchor" href="#features">§</a>Features</h2><h3 id="general-category"><a class="doc-anchor" href="#general-category">§</a><code>general-category</code></h3>
|
|
<p>Provides the most general classification of a character,
|
|
based on its primary characteristic.</p>
|
|
<h3 id="emoji"><a class="doc-anchor" href="#emoji">§</a><code>emoji</code></h3>
|
|
<p>Provides the emoji character properties of a character.</p>
|
|
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="general_category/index.html" title="mod unicode_properties::general_category">general_<wbr>category</a></div><div class="desc docblock-short">Query the general category property of a character.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.GeneralCategory.html" title="enum unicode_properties::GeneralCategory">General<wbr>Category</a></div><div class="desc docblock-short">The most general classification of a character.</div></li><li><div class="item-name"><a class="enum" href="enum.GeneralCategoryGroup.html" title="enum unicode_properties::GeneralCategoryGroup">General<wbr>Category<wbr>Group</a></div><div class="desc docblock-short">Groupings of the most general classification of a character.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.UNICODE_VERSION.html" title="constant unicode_properties::UNICODE_VERSION">UNICODE_<wbr>VERSION</a></div><div class="desc docblock-short">The version of <a href="http://www.unicode.org/">Unicode</a>
|
|
that this version of unicode-security is based on.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.UnicodeGeneralCategory.html" title="trait unicode_properties::UnicodeGeneralCategory">Unicode<wbr>General<wbr>Category</a></div><div class="desc docblock-short">Query the general category property of a character.</div></li></ul></section></div></main></body></html> |