blob: a0d2d3c42140cb9708a65701239aaef4ebed5a81 [file] [log] [blame]
<!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 to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/encode_unicode-0.1.3/src/lib.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>lib.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
</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"><pre class="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>
</pre><pre class="rust ">
<span class="comment">/* Copyright 2016 Torbjørn Birch Moltu
*
* Licensed under the Apache License, Version 2.0, &lt;LICENSE-APACHE or
* http://apache.org/licenses/LICENSE-2.0&gt; or the MIT license &lt;LICENSE-MIT or
* http://opensource.org/licenses/MIT&gt;, at your option. This file may not be
* copied, modified, or distributed except according to those terms.
*/</span>
<span class="doccomment">//! Alternative and extension to the unstable `char.encode_utf8()` and `char.encode_utf16()`.</span>
<span class="comment">// warnings</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">warn</span>(<span class="ident">missing_docs</span>)]</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;clippy&quot;</span>, <span class="ident">feature</span>(<span class="ident">plugin</span>))]</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;clippy&quot;</span>, <span class="ident">plugin</span>(<span class="ident">clippy</span>))]</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;clippy&quot;</span>, <span class="ident">allow</span>(<span class="ident">len_without_is_empty</span>))]</span><span class="comment">// UtfxChar is never empty</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;clippy&quot;</span>, <span class="ident">allow</span>(<span class="ident">match_same_arms</span>))]</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;clippy&quot;</span>, <span class="ident">allow</span>(<span class="ident">derive_hash_xor_eq</span>))]</span><span class="comment">// tested</span>
<span class="comment">// precedence: I prefer spaces to parentheses, but it&#39;s nice to recheck.</span>
<span class="attribute">#<span class="op">!</span>[<span class="ident">cfg_attr</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;ascii&quot;</span>, <span class="ident">feature</span>(<span class="ident">ascii</span>))]</span><span class="comment">// one is a crate, the other is a std feature</span>
<span class="kw">mod</span> <span class="ident">errors</span>;
<span class="kw">mod</span> <span class="ident">traits</span>;
<span class="kw">mod</span> <span class="ident">utf8_char</span>;
<span class="kw">mod</span> <span class="ident">utf8_iterator</span>;
<span class="kw">mod</span> <span class="ident">utf16_char</span>;
<span class="kw">mod</span> <span class="ident">utf16_iterator</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">traits</span>::<span class="ident">CharExt</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">utf8_char</span>::<span class="ident">Utf8Char</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">utf16_char</span>::<span class="ident">Utf16Char</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">utf8_iterator</span>::<span class="ident">Utf8Iterator</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">utf16_iterator</span>::<span class="ident">Utf16Iterator</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">traits</span>::<span class="ident">U8UtfExt</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">traits</span>::<span class="ident">U16UtfExt</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">error</span> {<span class="comment">// keeping the public interface in one file</span>
<span class="doccomment">//! Errors returned by various conversion methods in this crate.</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">utf8_char</span>::<span class="ident">FromStrError</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">errors</span>::{<span class="ident">InvalidCodePoint</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">errors</span>::{<span class="ident">InvalidUtf8FirstByte</span>,<span class="ident">InvalidUtf8</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">errors</span>::{<span class="ident">InvalidUtf8Slice</span>,<span class="ident">InvalidUtf16Slice</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">errors</span>::{<span class="ident">InvalidUtf8Array</span>,<span class="ident">InvalidUtf16Tuple</span>};
}
</pre>
</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 = "encode_unicode";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>