juniper/unicode_normalization/index.html

181 lines
8.5 KiB
HTML
Raw Normal View History

2016-09-11 13:41:24 -05: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 `unicode_normalization` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, unicode_normalization">
<title>unicode_normalization - Rust</title>
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
<link rel="shortcut icon" href="https://unicode-rs.github.io/unicode-rs_sm.png">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<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'></p><script>window.sidebarCurrent = {name: 'unicode_normalization', ty: 'mod', relpath: '../'};</script>
</nav>
<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 mod">
<h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>unicode_normalization</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 id='src-0' class='srclink' href='../src/unicode_normalization/lib.rs.html#11-138' title='goto source code'>[src]</a></span></h1>
<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>
<pre class='rust rust-example-rendered'>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>unicode_normalization</span>;
<span class='kw'>use</span> <span class='ident'>unicode_normalization</span>::<span class='ident'>char</span>::<span class='ident'>compose</span>;
<span class='kw'>use</span> <span class='ident'>unicode_normalization</span>::<span class='ident'>UnicodeNormalization</span>;
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>compose</span>(<span class='string'>&#39;A&#39;</span>,<span class='string'>&#39;\u{30a}&#39;</span>), <span class='prelude-val'>Some</span>(<span class='string'>&#39;Å&#39;</span>));
<span class='kw'>let</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='string'>&quot;ÅΩ&quot;</span>;
<span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='ident'>s</span>.<span class='ident'>nfc</span>().<span class='ident'>collect</span>::<span class='op'>&lt;</span><span class='ident'>String</span><span class='op'>&gt;</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>c</span>, <span class='string'>&quot;ÅΩ&quot;</span>);
}</pre>
<h1 id='cratesio' class='section-header'><a href='#cratesio'>crates.io</a></h1>
<p>You can use this package in your project by adding the following
to your <code>Cargo.toml</code>:</p>
<pre><code class="language-toml">[dependencies]
unicode-normalization = &quot;0.1.0&quot;
</code></pre>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class='mod' href='char/index.html'
title='unicode_normalization::char'>char</a></td>
<td class='docblock short'>
<p>Methods for composing and decomposing characters.</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.Decompositions.html'
title='unicode_normalization::Decompositions'>Decompositions</a></td>
<td class='docblock short'>
<p>External iterator for a string decomposition&#39;s characters.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Recompositions.html'
title='unicode_normalization::Recompositions'>Recompositions</a></td>
<td class='docblock short'>
<p>External iterator for a string recomposition&#39;s characters.</p>
</td>
</tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table>
<tr class=' module-item'>
<td><a class='constant' href='constant.UNICODE_VERSION.html'
title='unicode_normalization::UNICODE_VERSION'>UNICODE_VERSION</a></td>
<td class='docblock short'>
<p>The version of <a href="http://www.unicode.org/">Unicode</a>
that this version of unicode-normalization is based on.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class='trait' href='trait.UnicodeNormalization.html'
title='unicode_normalization::UnicodeNormalization'>UnicodeNormalization</a></td>
<td class='docblock short'>
<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>
</td>
</tr></table></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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>