mentat/docs/apis/rust/unicode_normalization/trait.UnicodeNormalization.html

162 lines
29 KiB
HTML
Raw Normal View History

2018-06-21 14:44:35 +00:00
<!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="API documentation for the Rust `UnicodeNormalization` trait in crate `unicode_normalization`.">
<meta name="keywords" content="rust, rustlang, rust-lang, UnicodeNormalization">
<title>unicode_normalization::UnicodeNormalization - Rust</title>
<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="../dark.css">
<link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
<script src="../storage.js"></script>
<link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png">
</head>
<body class="rustdoc trait">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<a href='../unicode_normalization/index.html'><img src='https://unicode-rs.github.io/unicode-rs_sm.png' alt='logo' width='100'></a>
<p class='location'>Trait UnicodeNormalization</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.nfd">nfd</a><a href="#tymethod.nfkd">nfkd</a><a href="#tymethod.nfc">nfc</a><a href="#tymethod.nfkc">nfkc</a><a href="#tymethod.stream_safe">stream_safe</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-UnicodeNormalization%3CChars%3C%27a%3E%3E">&amp;&#39;a str</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>unicode_normalization</a></p><script>window.sidebarCurrent = {name: 'UnicodeNormalization', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>unicode_normalization</a>::<wbr><a class="trait" href=''>UnicodeNormalization</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/unicode_normalization/lib.rs.html#88-113' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait UnicodeNormalization&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; {
fn <a href='#tymethod.nfd' class='fnname'>nfd</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.nfkd' class='fnname'>nfkd</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.nfc' class='fnname'>nfc</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.nfkc' class='fnname'>nfkc</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.stream_safe' class='fnname'>stream_safe</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.StreamSafe.html" title="struct unicode_normalization::StreamSafe">StreamSafe</a>&lt;I&gt;;
}</pre></div><div class='docblock'><p>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>.</p>
</div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>;</span></code></div></div><h3 id='tymethod.nfd' class='method'><span id='nfd.v' class='invisible'><code>fn <a href='#tymethod.nfd' class='fnname'>nfd</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</code></span></h3><div class='docblock'><p>Returns an iterator over the string in Unicode Normalization Form D
(canonical decomposition).</p>
</div><div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>;</span></code></div></div><h3 id='tymethod.nfkd' class='method'><span id='nfkd.v' class='invisible'><code>fn <a href='#tymethod.nfkd' class='fnname'>nfkd</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</code></span></h3><div class='docblock'><p>Returns an iterator over the string in Unicode Normalization Form KD
(compatibility decomposition).</p>
</div><div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>;</span></code></div></div><h3 id='tymethod.nfc' class='method'><span id='nfc.v' class='invisible'><code>fn <a href='#tymethod.nfc' class='fnname'>nfc</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</code></span></h3><div class='docblock'><p>An Iterator over the string in Unicode Normalization Form C
(canonical decomposition followed by canonical composition).</p>
</div><div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>;</span></code></div></div><h3 id='tymethod.nfkc' class='method'><span id='nfkc.v' class='invisible'><code>fn <a href='#tymethod.nfkc' class='fnname'>nfkc</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Recompositions.html" title="struct unicode_normalization::Recompositions">Recompositions</a>&lt;I&gt;</code></span></h3><div class='docblock'><p>An Iterator over the string in Unicode Normalization Form KC
(compatibility decomposition followed by canonical composition).</p>
</div><div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <a class="struct" href="../unicode_normalization/struct.StreamSafe.html" title="struct unicode_normalization::StreamSafe">StreamSafe</a>&lt;I&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../unicode_normalization/struct.StreamSafe.html" title="struct unicode_normalization::StreamSafe">StreamSafe</a>&lt;I&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../unicode_normalization/struct.StreamSafe.html" title="struct unicode_normalization::StreamSafe">StreamSafe</a>&lt;I&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>;</span></code></div></div><h3 id='tymethod.stream_safe' class='method'><span id='stream_safe.v' class='invisible'><code>fn <a href='#tymethod.stream_safe' class='fnname'>stream_safe</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.StreamSafe.html" title="struct unicode_normalization::StreamSafe">StreamSafe</a>&lt;I&gt;</code></span></h3><div class='docblock'><p>An Iterator over the string with Conjoining Grapheme Joiner characters
inserted according to the Stream-Safe Text Process (UAX15-D4)</p>
</div></div>
<h2 id='foreign-impls' class='small-section-header'>
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
</h2>
<h3 id='impl-UnicodeNormalization%3CChars%3C%27a%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a&gt; <a class="trait" href="../unicode_normalization/trait.UnicodeNormalization.html" title="trait unicode_normalization::UnicodeNormalization">UnicodeNormalization</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/core/str/struct.Chars.html" title="struct core::str::Chars">Chars</a>&lt;'a&gt;&gt; for &amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href='#impl-UnicodeNormalization%3CChars%3C%27a%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_normalization/lib.rs.html#115-140' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.nfd' class="method"><div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>;</span></code></div></div><span id='nfd.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.nfd' class='fnname'>nfd</a>(self) -&gt; <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/core/str/struct.Chars.html" title="struct core::str::Chars">Chars</a>&lt;'a&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/unicode_normalization/lib.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.nfkd' class="method"><div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../unicode_normalization/struct.Decompositions.html" title="struct unicode_normalization::Decompositions">Decompositions</a>&lt;I&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><table class='table-display'><tbody><tr><td><code>impl&lt;I:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>&gt;&gt; UnicodeNormalization&lt;I&gt; for I</code><td><div class='out-of-band'><a class='srclink' href='../src/unicode_normalization/lib.rs.html#142-167' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../implementors/unicode_normalization/trait.UnicodeNormalization.js">
</script></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "unicode_normalization";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>