| <!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="Unicode character composition and decomposition utilities as described in Unicode Standard Annex #15."><meta name="keywords" content="rust, rustlang, rust-lang, unicode_normalization"><title>unicode_normalization - 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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" 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="icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"></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="../unicode_normalization/index.html"><div class="logo-container"><img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../unicode_normalization/index.html"><div class="logo-container"> |
| <img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></div></a><h2 class="location"><a href="#">Crate unicode_normalization</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.22</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><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"><a href="../help.html">?</a></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><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">unicode_normalization</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></h1><span class="out-of-band"><a class="srclink" href="../src/unicode_normalization/lib.rs.html#11-235">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>Unicode character composition and decomposition utilities |
| as described in |
| <a href="http://www.unicode.org/reports/tr15/">Unicode Standard Annex #15</a>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">extern crate </span>unicode_normalization; |
| |
| <span class="kw">use </span>unicode_normalization::char::compose; |
| <span class="kw">use </span>unicode_normalization::UnicodeNormalization; |
| |
| <span class="kw">fn </span>main() { |
| <span class="macro">assert_eq!</span>(compose(<span class="string">'A'</span>,<span class="string">'\u{30a}'</span>), <span class="prelude-val">Some</span>(<span class="string">'Å'</span>)); |
| |
| <span class="kw">let </span>s = <span class="string">"ÅΩ"</span>; |
| <span class="kw">let </span>c = s.nfc().collect::<String>(); |
| <span class="macro">assert_eq!</span>(c, <span class="string">"ÅΩ"</span>); |
| }</code></pre></div> |
| <h2 id="cratesio"><a href="#cratesio">crates.io</a></h2> |
| <p>You can use this package in your project by adding the following |
| to your <code>Cargo.toml</code>:</p> |
| <div class="example-wrap"><pre class="language-toml"><code>[dependencies] |
| unicode-normalization = "0.1.20"</code></pre></div></div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="char/index.html" title="unicode_normalization::char mod">char</a></div><div class="item-right docblock-short">Methods for composing and decomposing characters.</div></div></div><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.Decompositions.html" title="unicode_normalization::Decompositions struct">Decompositions</a></div><div class="item-right docblock-short">External iterator for a string decomposition’s characters.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Recompositions.html" title="unicode_normalization::Recompositions struct">Recompositions</a></div><div class="item-right docblock-short">External iterator for a string recomposition’s characters.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Replacements.html" title="unicode_normalization::Replacements struct">Replacements</a></div><div class="item-right docblock-short">External iterator for replacements for a string’s characters.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StreamSafe.html" title="unicode_normalization::StreamSafe struct">StreamSafe</a></div><div class="item-right docblock-short">UAX15-D4: This iterator keeps track of how many non-starters there have been |
| since the last starter in <em>NFKD</em> and will emit a Combining Grapheme Joiner |
| (U+034F) if the count exceeds 30.</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.IsNormalized.html" title="unicode_normalization::IsNormalized enum">IsNormalized</a></div><div class="item-right docblock-short">The QuickCheck algorithm can quickly determine if a text is or isn’t |
| normalized without any allocations in many cases, but it has to be able to |
| return <code>Maybe</code> when a full decomposition and recomposition is necessary.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.UNICODE_VERSION.html" title="unicode_normalization::UNICODE_VERSION constant">UNICODE_VERSION</a></div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.UnicodeNormalization.html" title="unicode_normalization::UnicodeNormalization trait">UnicodeNormalization</a></div><div class="item-right docblock-short">Methods for iterating over strings while applying Unicode normalizations |
| as described in |
| <a href="http://www.unicode.org/reports/tr15/">Unicode Standard Annex #15</a>.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfc.html" title="unicode_normalization::is_nfc fn">is_nfc</a></div><div class="item-right docblock-short">Authoritatively check if a string is in NFC.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfc_quick.html" title="unicode_normalization::is_nfc_quick fn">is_nfc_quick</a></div><div class="item-right docblock-short">Quickly check if a string is in NFC, potentially returning |
| <code>IsNormalized::Maybe</code> if further checks are necessary. In this case a check |
| like <code>s.chars().nfc().eq(s.chars())</code> should suffice.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfc_stream_safe.html" title="unicode_normalization::is_nfc_stream_safe fn">is_nfc_stream_safe</a></div><div class="item-right docblock-short">Authoritatively check if a string is Stream-Safe NFC.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfc_stream_safe_quick.html" title="unicode_normalization::is_nfc_stream_safe_quick fn">is_nfc_stream_safe_quick</a></div><div class="item-right docblock-short">Quickly check if a string is Stream-Safe NFC.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfd.html" title="unicode_normalization::is_nfd fn">is_nfd</a></div><div class="item-right docblock-short">Authoritatively check if a string is in NFD.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfd_quick.html" title="unicode_normalization::is_nfd_quick fn">is_nfd_quick</a></div><div class="item-right docblock-short">Quickly check if a string is in NFD.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfd_stream_safe.html" title="unicode_normalization::is_nfd_stream_safe fn">is_nfd_stream_safe</a></div><div class="item-right docblock-short">Authoritatively check if a string is Stream-Safe NFD.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfd_stream_safe_quick.html" title="unicode_normalization::is_nfd_stream_safe_quick fn">is_nfd_stream_safe_quick</a></div><div class="item-right docblock-short">Quickly check if a string is Stream-Safe NFD.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfkc.html" title="unicode_normalization::is_nfkc fn">is_nfkc</a></div><div class="item-right docblock-short">Authoritatively check if a string is in NFKC.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfkc_quick.html" title="unicode_normalization::is_nfkc_quick fn">is_nfkc_quick</a></div><div class="item-right docblock-short">Quickly check if a string is in NFKC.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfkd.html" title="unicode_normalization::is_nfkd fn">is_nfkd</a></div><div class="item-right docblock-short">Authoritatively check if a string is in NFKD.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.is_nfkd_quick.html" title="unicode_normalization::is_nfkd_quick fn">is_nfkd_quick</a></div><div class="item-right docblock-short">Quickly check if a string is in NFKD.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="unicode_normalization" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
