blob: 157660647defbfe3f9777af8e87c37ca5ffc7457 [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 of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/htmlescape-0.3.1/src/io_support.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>io_support.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../htmlescape/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../htmlescape/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io::{Write, Read, Error, ErrorKind};
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::fmt;
<span class="kw">pub fn </span>write_char&lt;W: Write&gt;(writer: <span class="kw-2">&amp;mut </span>W, c: char) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>;<span class="number">4</span>];
<span class="kw">let </span>utf8 = encode_char_utf8(c, <span class="kw-2">&amp;mut </span>buf);
writer.write_all(utf8)
}
<span class="kw">fn </span>encode_char_utf8&lt;<span class="lifetime">&#39;a</span>&gt;(c: char, buf: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>[u8]) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8] {
<span class="kw">let </span>c = c <span class="kw">as </span>u32;
<span class="kw">if </span>c &lt;= <span class="number">0x7f </span>{
buf[<span class="number">0</span>] = c <span class="kw">as </span>u8;
<span class="kw-2">&amp;</span>buf[..<span class="number">1</span>]
} <span class="kw">else if </span>c &lt;= <span class="number">0x7ff </span>{
buf[<span class="number">1</span>] = <span class="number">0b10000000 </span>| (c &amp; <span class="number">0b00111111</span>) <span class="kw">as </span>u8;
buf[<span class="number">0</span>] = <span class="number">0b11000000 </span>| ((c &gt;&gt; <span class="number">6</span>) &amp; <span class="number">0b00011111</span>) <span class="kw">as </span>u8;
<span class="kw-2">&amp;</span>buf[..<span class="number">2</span>]
} <span class="kw">else if </span>c &lt;= <span class="number">0xffff </span>{
buf[<span class="number">2</span>] = <span class="number">0b10000000 </span>| (c &amp; <span class="number">0b00111111</span>) <span class="kw">as </span>u8;
buf[<span class="number">1</span>] = <span class="number">0b10000000 </span>| ((c &gt;&gt; <span class="number">6</span>) &amp; <span class="number">0b00111111</span>) <span class="kw">as </span>u8;
buf[<span class="number">0</span>] = <span class="number">0b11100000 </span>| ((c &gt;&gt; <span class="number">12</span>) &amp; <span class="number">0b00001111</span>) <span class="kw">as </span>u8;
<span class="kw-2">&amp;</span>buf[..<span class="number">3</span>]
} <span class="kw">else </span>{
buf[<span class="number">3</span>] = <span class="number">0b10000000 </span>| (c &amp; <span class="number">0b00111111</span>) <span class="kw">as </span>u8;
buf[<span class="number">2</span>] = <span class="number">0b10000000 </span>| ((c &gt;&gt; <span class="number">6</span>) &amp; <span class="number">0b00111111</span>) <span class="kw">as </span>u8;
buf[<span class="number">1</span>] = <span class="number">0b10000000 </span>| ((c &gt;&gt; <span class="number">12</span>) &amp; <span class="number">0b00111111</span>) <span class="kw">as </span>u8;
buf[<span class="number">0</span>] = <span class="number">0b11110000 </span>| ((c &gt;&gt; <span class="number">18</span>) &amp; <span class="number">0b00000111</span>) <span class="kw">as </span>u8;
<span class="kw-2">&amp;</span>buf[..<span class="number">4</span>]
}
}
<span class="kw">fn </span>utf8_char_bytes(first: u8) -&gt; usize {
<span class="kw">if </span>first &amp; <span class="number">0b10000000 </span>== <span class="number">0 </span>{
<span class="number">1
</span>} <span class="kw">else if </span>first &amp; <span class="number">0b11100000 </span>== <span class="number">0b11000000 </span>{
<span class="number">2
</span>} <span class="kw">else if </span>first &amp; <span class="number">0b11110000 </span>== <span class="number">0b11100000 </span>{
<span class="number">3
</span>} <span class="kw">else if </span>first &amp; <span class="number">0b11111000 </span>== <span class="number">0b11110000 </span>{
<span class="number">4
</span>} <span class="kw">else </span>{
<span class="number">0
</span>}
}
<span class="comment">// `Chars` code copied and modified from `std`
// The reason for doing this is that when using Chars from std, read_one_byte() isn&#39;t inlined.
// This is very painful when the backing Reader is just a Cursor over a byte array,
// and read_one_byte() should be much more than return buf[idx++] (+ check for end ofc.).
</span><span class="kw">pub struct </span>Chars&lt;R&gt; {
inner: R
}
<span class="kw">pub fn </span>chars&lt;R: Read&gt;(reader: R) -&gt; Chars&lt;R&gt; {
Chars { inner: reader }
}
<span class="attribute">#[derive(Debug)]
</span><span class="kw">pub enum </span>CharsError {
<span class="doccomment">/// Variant representing that the underlying stream was read successfully
/// but it did not contain valid utf8 data.
</span>NotUtf8,
<span class="doccomment">/// Variant representing that an I/O error occurred.
</span>Other(Error),
}
<span class="kw">impl</span>&lt;R: Read&gt; Iterator <span class="kw">for </span>Chars&lt;R&gt; {
<span class="kw">type </span>Item = <span class="prelude-ty">Result</span>&lt;char, CharsError&gt;;
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="prelude-ty">Result</span>&lt;char, CharsError&gt;&gt; {
<span class="kw">let </span>first_byte = <span class="kw">match </span>read_a_byte(<span class="kw-2">&amp;mut </span><span class="self">self</span>.inner) {
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(b)) =&gt; b,
<span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(e)) =&gt; <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(CharsError::Other(e))),
};
<span class="kw">let </span>width = utf8_char_bytes(first_byte);
<span class="kw">if </span>width == <span class="number">1 </span>{ <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(first_byte <span class="kw">as </span>char)) }
<span class="kw">if </span>width == <span class="number">0 </span>{ <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(CharsError::NotUtf8)) }
<span class="kw">let </span><span class="kw-2">mut </span>buf = [first_byte, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
{
<span class="kw">let </span><span class="kw-2">mut </span>start = <span class="number">1</span>;
<span class="kw">while </span>start &lt; width {
<span class="kw">match </span><span class="self">self</span>.inner.read(<span class="kw-2">&amp;mut </span>buf[start..width]) {
<span class="prelude-val">Ok</span>(<span class="number">0</span>) =&gt; <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(CharsError::NotUtf8)),
<span class="prelude-val">Ok</span>(n) =&gt; start += n,
<span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == ErrorKind::Interrupted =&gt; <span class="kw">continue</span>,
<span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(CharsError::Other(e))),
}
}
}
<span class="prelude-val">Some</span>(<span class="kw">match </span>::std::str::from_utf8(<span class="kw-2">&amp;</span>buf[..width]).ok() {
<span class="prelude-val">Some</span>(s) =&gt; <span class="prelude-val">Ok</span>(s.chars().next().unwrap()),
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">Err</span>(CharsError::NotUtf8),
})
}
}
<span class="kw">fn </span>read_a_byte&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; <span class="prelude-ty">Option</span>&lt;io::Result&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>];
<span class="kw">loop </span>{
<span class="kw">return match </span>reader.read(<span class="kw-2">&amp;mut </span>buf) {
<span class="prelude-val">Ok</span>(<span class="number">0</span>) =&gt; <span class="prelude-val">None</span>,
<span class="prelude-val">Ok</span>(..) =&gt; <span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(buf[<span class="number">0</span>])),
<span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == ErrorKind::Interrupted =&gt; <span class="kw">continue</span>,
<span class="prelude-val">Err</span>(e) =&gt; <span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(e)),
};
}
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>CharsError {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
CharsError::NotUtf8 =&gt; {
<span class="string">&quot;byte stream did not contain valid utf8&quot;</span>.fmt(f)
}
CharsError::Other(<span class="kw-2">ref </span>e) =&gt; e.fmt(f),
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use </span><span class="kw">super</span>::encode_char_utf8;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_encode_char_utf8() {
do_test_encode_char_utf8(<span class="string">&#39;$&#39;</span>, <span class="kw-2">&amp;</span>[<span class="number">0x24</span>]);
do_test_encode_char_utf8(<span class="string">&#39;¢&#39;</span>, <span class="kw-2">&amp;</span>[<span class="number">0xc2</span>, <span class="number">0xa2</span>]);
do_test_encode_char_utf8(<span class="string">&#39;€&#39;</span>, <span class="kw-2">&amp;</span>[<span class="number">0xe2</span>, <span class="number">0x82</span>, <span class="number">0xac</span>]);
do_test_encode_char_utf8(<span class="string">&#39;\u{10348}&#39;</span>, <span class="kw-2">&amp;</span>[<span class="number">0xf0</span>, <span class="number">0x90</span>, <span class="number">0x8d</span>, <span class="number">0x88</span>]);
}
<span class="kw">fn </span>do_test_encode_char_utf8(c: char, expected: <span class="kw-2">&amp;</span>[u8]) {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>;<span class="number">4</span>];
<span class="kw">let </span>utf8 = encode_char_utf8(c, <span class="kw-2">&amp;mut </span>buf);
<span class="macro">assert_eq!</span>(utf8, expected);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="htmlescape" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>