blob: ffe5e08448699676ce172eff1baaeca9be2c084d [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_char.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>utf8_char.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>
<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>
</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">pub</span> <span class="kw">use</span> <span class="ident">errors</span>::<span class="ident">FromStrError</span>;
<span class="kw">use</span> <span class="ident">error</span>::{<span class="ident">InvalidUtf8Slice</span>,<span class="ident">InvalidUtf8Array</span>};
<span class="kw">use</span> <span class="ident">Utf8Iterator</span>;
<span class="kw">use</span> <span class="ident">CharExt</span>;
<span class="kw">use</span> <span class="ident">U8UtfExt</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">hash</span>,<span class="ident">fmt</span>, <span class="ident">str</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">borrow</span>::<span class="ident">Borrow</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">Deref</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">transmute</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;ascii&quot;</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ascii</span>::<span class="ident">AsciiExt</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;ascii&quot;</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ascii</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;ascii&quot;</span>)]</span>
<span class="kw">use</span> <span class="self">self</span>::<span class="ident">ascii</span>::{<span class="ident">Ascii</span>,<span class="ident">AsciiCast</span>};
<span class="comment">// I don&#39;t think there is any good default value for char, but char does.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>)]</span>
<span class="comment">// char doesn&#39;t do anything more advanced than u32 for Eq/Ord, so we shouldn&#39;t either.</span>
<span class="comment">// The default impl of Ord for arrays works out because longer codepoints</span>
<span class="comment">// start with more ones, so if they&#39;re equal, the length is the same,</span>
<span class="comment">// breaks down for values above 0x1f_ff_ff but those can only be created by unsafe code.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">PartialEq</span>,<span class="ident">Eq</span>, <span class="ident">PartialOrd</span>,<span class="ident">Ord</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>,<span class="ident">Copy</span>)]</span>
<span class="doccomment">/// Store a `char` as UTF-8 so it can be borrowed as a `str`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Has the same size as `char`, and is a `[u8;4]`</span>
<span class="doccomment">/// with the invariant that the first nth bytes are valid UTF-8, and the remaining are zero.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Utf8Char</span> {
<span class="ident">bytes</span>: [<span class="ident">u8</span>; <span class="number">4</span>],
}
<span class="comment">/////////////////////</span>
<span class="comment">//conversion traits//</span>
<span class="comment">/////////////////////</span>
<span class="kw">impl</span> <span class="ident">str</span>::<span class="ident">FromStr</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">type</span> <span class="prelude-val">Err</span> <span class="op">=</span> <span class="ident">FromStrError</span>;
<span class="doccomment">/// The string must contain exactly one codepoint</span>
<span class="kw">fn</span> <span class="ident">from_str</span>(<span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="ident">FromStrError</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">uc</span> <span class="op">=</span> <span class="ident">Utf8Char</span>::<span class="ident">default</span>();
<span class="kw">for</span> (<span class="ident">src</span>, <span class="ident">dst</span>) <span class="kw">in</span> <span class="ident">s</span>.<span class="ident">as_bytes</span>().<span class="ident">iter</span>().<span class="ident">zip</span>(<span class="ident">uc</span>.<span class="ident">bytes</span>.<span class="ident">iter_mut</span>()) {
<span class="kw-2">*</span><span class="ident">dst</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">src</span>;<span class="comment">// happens min(s.len(), 4) times</span>
}
<span class="kw">if</span> <span class="ident">uc</span>.<span class="ident">len</span>() <span class="op">==</span> <span class="ident">s</span>.<span class="ident">len</span>() {<span class="prelude-val">Ok</span>(<span class="ident">uc</span>)}
<span class="kw">else</span> <span class="kw">if</span> <span class="ident">s</span>.<span class="ident">is_empty</span>() {<span class="prelude-val">Err</span>(<span class="ident">FromStrError</span>::<span class="ident">Empty</span>)}
<span class="kw">else</span> {<span class="prelude-val">Err</span>(<span class="ident">FromStrError</span>::<span class="ident">SeveralCodePoints</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">Utf8Char</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="ident">Utf8Char</span>{ <span class="ident">bytes</span>: <span class="ident">c</span>.<span class="ident">to_utf8_array</span>().<span class="number">0</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">char</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="ident">char</span> {
<span class="kw">unsafe</span>{ <span class="ident">char</span>::<span class="ident">from_utf8_exact_slice_unchecked</span>(<span class="kw-2">&amp;</span><span class="ident">uc</span>.<span class="ident">bytes</span>[..<span class="ident">uc</span>.<span class="ident">len</span>()]) }
}
}
<span class="kw">impl</span> <span class="ident">IntoIterator</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">type</span> <span class="ident">Item</span><span class="op">=</span><span class="ident">u8</span>;
<span class="kw">type</span> <span class="ident">IntoIter</span><span class="op">=</span><span class="ident">Utf8Iterator</span>;
<span class="doccomment">/// Iterate over the byte values.</span>
<span class="kw">fn</span> <span class="ident">into_iter</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Utf8Iterator</span> {
<span class="ident">Utf8Iterator</span>::<span class="ident">from</span>(<span class="self">self</span>)
}
}
<span class="comment">/////////////////</span>
<span class="comment">//getter traits//</span>
<span class="comment">/////////////////</span>
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span>[<span class="ident">u8</span>] {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">bytes</span>[..<span class="self">self</span>.<span class="ident">len</span>()]
}
}
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op">&lt;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">str</span> {
<span class="kw">unsafe</span>{ <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">from_utf8_unchecked</span>( <span class="self">self</span>.<span class="ident">as_ref</span>() ) }
}
}
<span class="kw">impl</span> <span class="ident">Borrow</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span>[<span class="ident">u8</span>] {
<span class="self">self</span>.<span class="ident">as_ref</span>()
}
}
<span class="kw">impl</span> <span class="ident">Borrow</span><span class="op">&lt;</span><span class="ident">str</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="ident">str</span> {
<span class="self">self</span>.<span class="ident">as_ref</span>()
}
}
<span class="kw">impl</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">str</span>;
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="kw-2">&amp;</span><span class="self">Self</span>::<span class="ident">Target</span> {
<span class="self">self</span>.<span class="ident">as_ref</span>()
}
}
<span class="comment">////////////////</span>
<span class="comment">//ascii traits//</span>
<span class="comment">////////////////</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;ascii&quot;</span>)]</span>
<span class="doccomment">/// Requires feature &quot;ascii&quot;.</span>
<span class="kw">impl</span> <span class="ident">AsciiExt</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">type</span> <span class="ident">Owned</span> <span class="op">=</span> <span class="ident">Utf8Char</span>;
<span class="kw">fn</span> <span class="ident">is_ascii</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">bytes</span>[<span class="number">0</span>].<span class="ident">is_ascii</span>()
}
<span class="kw">fn</span> <span class="ident">eq_ignore_ascii_case</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&amp;</span><span class="self">Self</span>) <span class="op">-&gt;</span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">to_char</span>().<span class="ident">eq_ignore_ascii_case</span>(<span class="kw-2">&amp;</span><span class="ident">other</span>.<span class="ident">to_char</span>())
}
<span class="kw">fn</span> <span class="ident">to_ascii_uppercase</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="self">Self</span>::<span class="ident">Owned</span> {
<span class="kw">let</span> <span class="ident">ascii</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">bytes</span>[<span class="number">0</span>].<span class="ident">to_ascii_uppercase</span>();
<span class="kw">if</span> <span class="ident">ascii</span> <span class="op">==</span> <span class="self">self</span>.<span class="ident">bytes</span>[<span class="number">0</span>] {<span class="kw-2">*</span><span class="self">self</span>}
<span class="kw">else</span> {<span class="ident">Utf8Char</span>{ <span class="ident">bytes</span>: [<span class="ident">ascii</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">0</span>] }}
}
<span class="kw">fn</span> <span class="ident">to_ascii_lowercase</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="self">Self</span>::<span class="ident">Owned</span> {
<span class="kw">let</span> <span class="ident">ascii</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">bytes</span>[<span class="number">0</span>].<span class="ident">to_ascii_lowercase</span>();
<span class="kw">if</span> <span class="ident">ascii</span> <span class="op">==</span> <span class="self">self</span>.<span class="ident">bytes</span>[<span class="number">0</span>] {<span class="kw-2">*</span><span class="self">self</span>}<span class="comment">// unchanged</span>
<span class="kw">else</span> {<span class="ident">Utf8Char</span>{ <span class="ident">bytes</span>: [<span class="ident">ascii</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">0</span>] }}<span class="comment">// is ascii</span>
}
<span class="comment">// Theese methods are what prevents this from becoming stable</span>
<span class="kw">fn</span> <span class="ident">make_ascii_uppercase</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="kw-2">*</span><span class="self">self</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">to_ascii_uppercase</span>()
}
<span class="kw">fn</span> <span class="ident">make_ascii_lowercase</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="kw-2">*</span><span class="self">self</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">to_ascii_lowercase</span>();
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;ascii&quot;</span>)]</span>
<span class="doccomment">/// Requires feature &quot;ascii&quot;.</span>
<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">Ascii</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">ac</span>: <span class="ident">Ascii</span>) <span class="op">-&gt;</span> <span class="self">Self</span> {
<span class="ident">Utf8Char</span>{ <span class="ident">bytes</span>: [<span class="ident">ac</span>.<span class="ident">as_byte</span>(),<span class="number">0</span>,<span class="number">0</span>,<span class="number">0</span>] }
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span><span class="op">=</span><span class="string">&quot;ascii&quot;</span>)]</span>
<span class="doccomment">/// Requires feature &quot;ascii&quot;.</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">AsciiCast</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">Ascii</span>;
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">to_ascii_nocheck</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Ascii</span> {
<span class="self">self</span>.<span class="ident">bytes</span>[<span class="number">0</span>].<span class="ident">to_ascii_nocheck</span>()
}
}
<span class="comment">/////////////////////////////////////////////////////////</span>
<span class="comment">//Genaral traits that cannot be derived to emulate char//</span>
<span class="comment">/////////////////////////////////////////////////////////</span>
<span class="kw">impl</span> <span class="ident">hash</span>::<span class="ident">Hash</span> <span class="kw">for</span> <span class="ident">Utf8Char</span> {
<span class="kw">fn</span> <span class="ident">hash</span><span class="op">&lt;</span><span class="ident">H</span> : <span class="ident">hash</span>::<span class="ident">Hasher</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">state</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">H</span>) {
<span class="self">self</span>.<span class="ident">to_char</span>().<span class="ident">hash</span>(<span class="ident">state</span>);
}
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Utf8Char</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="ident">fmt</span>::<span class="ident">Debug</span>::<span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">to_char</span>(), <span class="ident">fmtr</span>)
}
}
<span class="comment">///////////////////////////////////////////////////////</span>
<span class="comment">//pub impls that should be together for nicer rustdoc//</span>
<span class="comment">///////////////////////////////////////////////////////</span>
<span class="kw">impl</span> <span class="ident">Utf8Char</span> {
<span class="doccomment">/// Validate the start of a UTF-8 slice and store it.</span>
<span class="doccomment">/// Also returns how many bytes were needed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If it&#39;s a str and you know it contains only one codepoint,</span>
<span class="doccomment">/// use `.from_str()` to skip the validation.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_slice_start</span>(<span class="ident">src</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(<span class="self">Self</span>,<span class="ident">usize</span>),<span class="ident">InvalidUtf8Slice</span><span class="op">&gt;</span> {
<span class="comment">// need to convert to char to check codepoint, but not convert back.</span>
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">char</span>::<span class="ident">from_utf8_slice</span>(<span class="ident">src</span>)).<span class="number">1</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">uc</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">default</span>();
<span class="kw">for</span> (<span class="ident">dst</span>, <span class="ident">src</span>) <span class="kw">in</span> <span class="ident">uc</span>.<span class="ident">bytes</span>.<span class="ident">iter_mut</span>().<span class="ident">zip</span>(<span class="ident">src</span>).<span class="ident">take</span>(<span class="ident">len</span>) {
<span class="kw-2">*</span><span class="ident">dst</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">src</span>;
}
<span class="prelude-val">Ok</span>((<span class="ident">uc</span>,<span class="ident">len</span>))
}
<span class="doccomment">/// Validate the array and store it.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_array</span>(<span class="ident">utf8</span>: [<span class="ident">u8</span>;<span class="number">4</span>]) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="self">Self</span>,<span class="ident">InvalidUtf8Array</span><span class="op">&gt;</span> {
<span class="macro">try</span><span class="macro">!</span>(<span class="ident">char</span>::<span class="ident">from_utf8_array</span>(<span class="ident">utf8</span>));
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">Utf8Char</span>{ <span class="ident">bytes</span>: <span class="ident">utf8</span> }.<span class="ident">len</span>() <span class="kw">as</span> <span class="ident">u32</span>;
<span class="kw">let</span> <span class="ident">mask</span> <span class="op">=</span> <span class="ident">u32</span>::<span class="ident">from_le</span>(<span class="number">0xff_ff_ff_ff</span> <span class="op">&gt;&gt;</span> <span class="number">8</span><span class="kw-2">*</span>(<span class="number">4</span><span class="op">-</span><span class="ident">len</span>));
<span class="kw">let</span> <span class="ident">unused_zeroed</span> <span class="op">=</span> <span class="ident">mask</span> <span class="op">&amp;</span> <span class="kw">unsafe</span>{ <span class="ident">transmute</span>::<span class="op">&lt;</span>_,<span class="ident">u32</span><span class="op">&gt;</span>(<span class="ident">utf8</span>) };
<span class="prelude-val">Ok</span>(<span class="kw">unsafe</span>{ <span class="ident">transmute</span>(<span class="ident">unused_zeroed</span>) })
}
<span class="doccomment">/// Result is 1...4 and identical to `.as_ref().len()` or `.as_char().len_utf8()`.</span>
<span class="doccomment">/// There is no .is_emty() because it would always return false.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">len</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="ident">bytes</span>[<span class="number">0</span>].<span class="ident">extra_utf8_bytes_unchecked</span>() <span class="op">+</span> <span class="number">1</span>
}
<span class="doccomment">/// Convert from UTF-8 to UTF-32</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_char</span>(<span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">char</span> {
<span class="self">self</span>.<span class="ident">into</span>()
}
<span class="doccomment">/// Write the internal representation to a slice,</span>
<span class="doccomment">/// and then returns the number of bytes written.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `None` is returned if the buffer is too small; then the buffer is left unmodified.</span>
<span class="doccomment">/// A buffer of length four is always large enough.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_slice</span>(<span class="self">self</span>, <span class="ident">dst</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">Option</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">len</span>() <span class="op">&lt;=</span> <span class="ident">dst</span>.<span class="ident">len</span>() {
<span class="kw">for</span> (<span class="ident">dst</span>, <span class="ident">src</span>) <span class="kw">in</span> <span class="ident">dst</span>.<span class="ident">iter_mut</span>().<span class="ident">zip</span>(<span class="self">self</span>.<span class="ident">bytes</span>.<span class="ident">iter</span>()) {
<span class="kw-2">*</span><span class="ident">dst</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">src</span>;
}
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">len</span>())
} <span class="kw">else</span> {
<span class="prelude-val">None</span>
}
}
<span class="doccomment">/// Expose the internal array and the number of used bytes.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_array</span>(<span class="self">self</span>) <span class="op">-&gt;</span> ([<span class="ident">u8</span>;<span class="number">4</span>],<span class="ident">usize</span>) {
(<span class="self">self</span>.<span class="ident">bytes</span>, <span class="self">self</span>.<span class="ident">len</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>