blob: cb68fbc6b1b2693092cccf40f6a0c09434875d56 [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/utf8_iterator.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>utf8_iterator.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>
<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>
</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="kw">use</span> <span class="ident">Utf8Char</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">std</span>;
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">fmt</span>,<span class="ident">mem</span>,<span class="ident">u32</span>,<span class="ident">u64</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">Not</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::{<span class="ident">Read</span>, <span class="ident">Error</span> <span class="kw">as</span> <span class="ident">ioError</span>};
<span class="doccomment">/// Read or iterate over the bytes in the UTF-8 representation of a codepoint.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>,<span class="ident">Copy</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Utf8Iterator</span> (<span class="ident">u32</span>);
<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">Utf8Char</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Iterator</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">uc</span>: <span class="ident">Utf8Char</span>) <span class="op">-&gt;</span> <span class="self">Self</span> {
<span class="kw">let</span> <span class="ident">used</span> <span class="op">=</span> <span class="ident">u32</span>::<span class="ident">from_le</span>(<span class="kw">unsafe</span>{ <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">uc</span>) });
<span class="comment">// uses u64 because shifting an u32 by 32 bits is a no-op.</span>
<span class="kw">let</span> <span class="ident">unused_set</span> <span class="op">=</span> (<span class="ident">u64</span>::<span class="ident">MAX</span> <span class="op">&lt;&lt;</span> <span class="ident">uc</span>.<span class="ident">len</span>() <span class="kw">as</span> <span class="ident">u64</span><span class="kw-2">*</span><span class="number">8</span>) <span class="kw">as</span> <span class="ident">u32</span>;
<span class="ident">Utf8Iterator</span>(<span class="ident">used</span> <span class="op">|</span> <span class="ident">unused_set</span>)
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">char</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Iterator</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">c</span>: <span class="ident">char</span>) <span class="op">-&gt;</span> <span class="self">Self</span> {
<span class="self">Self</span>::<span class="ident">from</span>(<span class="ident">Utf8Char</span>::<span class="ident">from</span>(<span class="ident">c</span>))
}
}
<span class="kw">impl</span> <span class="ident">Iterator</span> <span class="kw">for</span> <span class="ident">Utf8Iterator</span> {
<span class="kw">type</span> <span class="ident">Item</span><span class="op">=</span><span class="ident">u8</span>;
<span class="kw">fn</span> <span class="ident">next</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">next</span> <span class="op">=</span> <span class="self">self</span>.<span class="number">0</span> <span class="kw">as</span> <span class="ident">u8</span>;
<span class="kw">if</span> <span class="ident">next</span> <span class="op">==</span> <span class="number">0xff</span> {
<span class="prelude-val">None</span>
} <span class="kw">else</span> {
<span class="self">self</span>.<span class="number">0</span> <span class="op">=</span> (<span class="self">self</span>.<span class="number">0</span> <span class="op">&gt;&gt;</span> <span class="number">8</span>) <span class="op">|</span> <span class="number">0xff_00_00_00</span>;
<span class="prelude-val">Some</span>(<span class="ident">next</span>)
}
}
<span class="kw">fn</span> <span class="ident">size_hint</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> (<span class="ident">usize</span>, <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span>) {
(<span class="self">self</span>.<span class="ident">len</span>(), <span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">len</span>()))
}
}
<span class="kw">impl</span> <span class="ident">ExactSizeIterator</span> <span class="kw">for</span> <span class="ident">Utf8Iterator</span> {
<span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">usize</span> {<span class="comment">// not straightforward, but possible</span>
<span class="kw">let</span> <span class="ident">unused_bytes</span> <span class="op">=</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">not</span>().<span class="ident">leading_zeros</span>() <span class="op">/</span> <span class="number">8</span>;
<span class="number">4</span> <span class="op">-</span> <span class="ident">unused_bytes</span> <span class="kw">as</span> <span class="ident">usize</span>
}
}
<span class="kw">impl</span> <span class="ident">Read</span> <span class="kw">for</span> <span class="ident">Utf8Iterator</span> {
<span class="doccomment">/// Always returns Ok</span>
<span class="kw">fn</span> <span class="ident">read</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span>[<span class="ident">u8</span>]) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">usize</span>, <span class="ident">ioError</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">wrote</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">ptr</span>) <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">get_mut</span>(<span class="ident">wrote</span>) {<span class="comment">// while loop because I need the counter afterwards</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">b</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">next</span>() {<span class="comment">// don&#39;t call self.next() untill I know I can write the result.</span>
<span class="kw-2">*</span><span class="ident">ptr</span> <span class="op">=</span> <span class="ident">b</span>;
<span class="ident">wrote</span> <span class="op">+=</span> <span class="number">1</span>;
} <span class="kw">else</span> {
<span class="kw">break</span>;
}
}
<span class="prelude-val">Ok</span>(<span class="ident">wrote</span>)
}
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Utf8Iterator</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">fmtr</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-&gt;</span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">let</span> <span class="ident">content</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">collect</span>();
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmtr</span>, <span class="string">&quot;bytes left: {:?}, content: {:x}&quot;</span>, <span class="ident">content</span>, <span class="self">self</span>.<span class="number">0</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>