| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-normalization-0.1.22/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../unicode_normalization/index.html"> |
| <img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT |
| // file at the top-level directory of this distribution and at |
| // http://rust-lang.org/COPYRIGHT. |
| // |
| // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or |
| // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license |
| // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your |
| // option. This file may not be copied, modified, or distributed |
| // except according to those terms. |
| |
| </span><span class="doccomment">//! Unicode character composition and decomposition utilities |
| //! as described in |
| //! [Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/). |
| //! |
| //! ```rust |
| //! extern crate unicode_normalization; |
| //! |
| //! use unicode_normalization::char::compose; |
| //! use unicode_normalization::UnicodeNormalization; |
| //! |
| //! fn main() { |
| //! assert_eq!(compose('A','\u{30a}'), Some('Å')); |
| //! |
| //! let s = "ÅΩ"; |
| //! let c = s.nfc().collect::<String>(); |
| //! assert_eq!(c, "ÅΩ"); |
| //! } |
| //! ``` |
| //! |
| //! # crates.io |
| //! |
| //! You can use this package in your project by adding the following |
| //! to your `Cargo.toml`: |
| //! |
| //! ```toml |
| //! [dependencies] |
| //! unicode-normalization = "0.1.20" |
| //! ``` |
| |
| </span><span class="attribute">#![deny(missing_docs, unsafe_code)] |
| #![doc( |
| html_logo_url = <span class="string">"https://unicode-rs.github.io/unicode-rs_sm.png"</span>, |
| html_favicon_url = <span class="string">"https://unicode-rs.github.io/unicode-rs_sm.png" |
| </span>)] |
| #![cfg_attr(not(feature = <span class="string">"std"</span>), no_std)] |
| |
| #[cfg(not(feature = <span class="string">"std"</span>))] |
| </span><span class="kw">extern crate </span>alloc; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">extern crate </span>core; |
| |
| <span class="kw">extern crate </span>tinyvec; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::decompose::Decompositions; |
| <span class="kw">pub use </span><span class="kw">crate</span>::quick_check::{ |
| is_nfc, is_nfc_quick, is_nfc_stream_safe, is_nfc_stream_safe_quick, is_nfd, is_nfd_quick, |
| is_nfd_stream_safe, is_nfd_stream_safe_quick, is_nfkc, is_nfkc_quick, is_nfkd, is_nfkd_quick, |
| IsNormalized, |
| }; |
| <span class="kw">pub use </span><span class="kw">crate</span>::recompose::Recompositions; |
| <span class="kw">pub use </span><span class="kw">crate</span>::replace::Replacements; |
| <span class="kw">pub use </span><span class="kw">crate</span>::stream_safe::StreamSafe; |
| <span class="kw">pub use </span><span class="kw">crate</span>::tables::UNICODE_VERSION; |
| <span class="kw">use </span>core::{ |
| str::Chars, |
| option, |
| }; |
| |
| <span class="kw">mod </span>no_std_prelude; |
| |
| <span class="kw">mod </span>decompose; |
| <span class="kw">mod </span>lookups; |
| <span class="kw">mod </span>normalize; |
| <span class="kw">mod </span>perfect_hash; |
| <span class="kw">mod </span>quick_check; |
| <span class="kw">mod </span>recompose; |
| <span class="kw">mod </span>replace; |
| <span class="kw">mod </span>stream_safe; |
| |
| <span class="attribute">#[rustfmt::skip] |
| </span><span class="kw">mod </span>tables; |
| |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub mod </span>__test_api; |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test; |
| |
| <span class="doccomment">/// Methods for composing and decomposing characters. |
| </span><span class="kw">pub mod </span>char { |
| <span class="kw">pub use </span><span class="kw">crate</span>::normalize::{ |
| compose, decompose_canonical, decompose_cjk_compat_variants, decompose_compatible, |
| }; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::lookups::{canonical_combining_class, is_combining_mark}; |
| |
| <span class="doccomment">/// Return whether the given character is assigned (`General_Category` != `Unassigned`) |
| /// and not Private-Use (`General_Category` != `Private_Use`), in the supported version |
| /// of Unicode. |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::tables::is_public_assigned; |
| } |
| |
| <span class="doccomment">/// Methods for iterating over strings while applying Unicode normalizations |
| /// as described in |
| /// [Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/). |
| </span><span class="kw">pub trait </span>UnicodeNormalization<I: Iterator<Item = char>> { |
| <span class="doccomment">/// Returns an iterator over the string in Unicode Normalization Form D |
| /// (canonical decomposition). |
| </span><span class="kw">fn </span>nfd(<span class="self">self</span>) -> Decompositions<I>; |
| |
| <span class="doccomment">/// Returns an iterator over the string in Unicode Normalization Form KD |
| /// (compatibility decomposition). |
| </span><span class="kw">fn </span>nfkd(<span class="self">self</span>) -> Decompositions<I>; |
| |
| <span class="doccomment">/// An Iterator over the string in Unicode Normalization Form C |
| /// (canonical decomposition followed by canonical composition). |
| </span><span class="kw">fn </span>nfc(<span class="self">self</span>) -> Recompositions<I>; |
| |
| <span class="doccomment">/// An Iterator over the string in Unicode Normalization Form KC |
| /// (compatibility decomposition followed by canonical composition). |
| </span><span class="kw">fn </span>nfkc(<span class="self">self</span>) -> Recompositions<I>; |
| |
| <span class="doccomment">/// A transformation which replaces CJK Compatibility Ideograph codepoints |
| /// with normal forms using Standardized Variation Sequences. This is not |
| /// part of the canonical or compatibility decomposition algorithms, but |
| /// performing it before those algorithms produces normalized output which |
| /// better preserves the intent of the original text. |
| /// |
| /// Note that many systems today ignore variation selectors, so these |
| /// may not immediately help text display as intended, but they at |
| /// least preserve the information in a standardized form, giving |
| /// implementations the option to recognize them. |
| </span><span class="kw">fn </span>cjk_compat_variants(<span class="self">self</span>) -> Replacements<I>; |
| |
| <span class="doccomment">/// An Iterator over the string with Conjoining Grapheme Joiner characters |
| /// inserted according to the Stream-Safe Text Process (UAX15-D4) |
| </span><span class="kw">fn </span>stream_safe(<span class="self">self</span>) -> StreamSafe<I>; |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> UnicodeNormalization<Chars<<span class="lifetime">'a</span>>> <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span>str { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfd(<span class="self">self</span>) -> Decompositions<Chars<<span class="lifetime">'a</span>>> { |
| decompose::new_canonical(<span class="self">self</span>.chars()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfkd(<span class="self">self</span>) -> Decompositions<Chars<<span class="lifetime">'a</span>>> { |
| decompose::new_compatible(<span class="self">self</span>.chars()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfc(<span class="self">self</span>) -> Recompositions<Chars<<span class="lifetime">'a</span>>> { |
| recompose::new_canonical(<span class="self">self</span>.chars()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfkc(<span class="self">self</span>) -> Recompositions<Chars<<span class="lifetime">'a</span>>> { |
| recompose::new_compatible(<span class="self">self</span>.chars()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>cjk_compat_variants(<span class="self">self</span>) -> Replacements<Chars<<span class="lifetime">'a</span>>> { |
| replace::new_cjk_compat_variants(<span class="self">self</span>.chars()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>stream_safe(<span class="self">self</span>) -> StreamSafe<Chars<<span class="lifetime">'a</span>>> { |
| StreamSafe::new(<span class="self">self</span>.chars()) |
| } |
| } |
| |
| |
| <span class="kw">impl </span>UnicodeNormalization<option::IntoIter<char>> <span class="kw">for </span>char { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfd(<span class="self">self</span>) -> Decompositions<option::IntoIter<char>> { |
| decompose::new_canonical(<span class="prelude-val">Some</span>(<span class="self">self</span>).into_iter()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfkd(<span class="self">self</span>) -> Decompositions<option::IntoIter<char>> { |
| decompose::new_compatible(<span class="prelude-val">Some</span>(<span class="self">self</span>).into_iter()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfc(<span class="self">self</span>) -> Recompositions<option::IntoIter<char>> { |
| recompose::new_canonical(<span class="prelude-val">Some</span>(<span class="self">self</span>).into_iter()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfkc(<span class="self">self</span>) -> Recompositions<option::IntoIter<char>> { |
| recompose::new_compatible(<span class="prelude-val">Some</span>(<span class="self">self</span>).into_iter()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>cjk_compat_variants(<span class="self">self</span>) -> Replacements<option::IntoIter<char>> { |
| replace::new_cjk_compat_variants(<span class="prelude-val">Some</span>(<span class="self">self</span>).into_iter()) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>stream_safe(<span class="self">self</span>) -> StreamSafe<option::IntoIter<char>> { |
| StreamSafe::new(<span class="prelude-val">Some</span>(<span class="self">self</span>).into_iter()) |
| } |
| } |
| |
| <span class="kw">impl</span><I: Iterator<Item = char>> UnicodeNormalization<I> <span class="kw">for </span>I { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfd(<span class="self">self</span>) -> Decompositions<I> { |
| decompose::new_canonical(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfkd(<span class="self">self</span>) -> Decompositions<I> { |
| decompose::new_compatible(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfc(<span class="self">self</span>) -> Recompositions<I> { |
| recompose::new_canonical(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>nfkc(<span class="self">self</span>) -> Recompositions<I> { |
| recompose::new_compatible(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>cjk_compat_variants(<span class="self">self</span>) -> Replacements<I> { |
| replace::new_cjk_compat_variants(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>stream_safe(<span class="self">self</span>) -> StreamSafe<I> { |
| StreamSafe::new(<span class="self">self</span>) |
| } |
| } |
| </code></pre></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> |
