blob: 4b1fc7a2674323d0759f64a4d543d8eb41c68989 [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/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/common/src/serialize.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>serialize.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="../../tantivy_common/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="../../tantivy_common/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>
<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>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::io::{Read, Write};
<span class="kw">use </span>std::{fmt, io};
<span class="kw">use </span>byteorder::{ReadBytesExt, WriteBytesExt};
<span class="kw">use crate</span>::{Endianness, VInt};
<span class="doccomment">/// Trait for a simple binary serialization.
</span><span class="kw">pub trait </span>BinarySerializable: fmt::Debug + Sized {
<span class="doccomment">/// Serialize
</span><span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt;;
<span class="doccomment">/// Deserialize
</span><span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt;;
}
<span class="kw">pub trait </span>DeserializeFrom&lt;T: BinarySerializable&gt; {
<span class="kw">fn </span>deserialize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;T&gt;;
}
<span class="doccomment">/// Implement deserialize from &amp;[u8] for all types which implement BinarySerializable.
///
/// TryFrom would actually be preferable, but not possible because of the orphan
/// rules (not completely sure if this could be resolved)
</span><span class="kw">impl</span>&lt;T: BinarySerializable&gt; DeserializeFrom&lt;T&gt; <span class="kw">for </span><span class="kw-2">&amp;</span>[u8] {
<span class="kw">fn </span>deserialize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;T&gt; {
T::deserialize(<span class="self">self</span>)
}
}
<span class="doccomment">/// `FixedSize` marks a `BinarySerializable` as
/// always serializing to the same size.
</span><span class="kw">pub trait </span>FixedSize: BinarySerializable {
<span class="kw">const </span>SIZE_IN_BYTES: usize;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>() {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(<span class="kw">_</span>: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>() {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">0</span>;
}
<span class="kw">impl</span>&lt;T: BinarySerializable&gt; BinarySerializable <span class="kw">for </span>Vec&lt;T&gt; {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
VInt(<span class="self">self</span>.len() <span class="kw">as </span>u64).serialize(writer)<span class="question-mark">?</span>;
<span class="kw">for </span>it <span class="kw">in </span><span class="self">self </span>{
it.serialize(writer)<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;Vec&lt;T&gt;&gt; {
<span class="kw">let </span>num_items = VInt::deserialize(reader)<span class="question-mark">?</span>.val();
<span class="kw">let </span><span class="kw-2">mut </span>items: Vec&lt;T&gt; = Vec::with_capacity(num_items <span class="kw">as </span>usize);
<span class="kw">for _ in </span><span class="number">0</span>..num_items {
<span class="kw">let </span>item = T::deserialize(reader)<span class="question-mark">?</span>;
items.push(item);
}
<span class="prelude-val">Ok</span>(items)
}
}
<span class="kw">impl</span>&lt;Left: BinarySerializable, Right: BinarySerializable&gt; BinarySerializable <span class="kw">for </span>(Left, Right) {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, write: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.<span class="number">0</span>.serialize(write)<span class="question-mark">?</span>;
<span class="self">self</span>.<span class="number">1</span>.serialize(write)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<span class="prelude-val">Ok</span>((Left::deserialize(reader)<span class="question-mark">?</span>, Right::deserialize(reader)<span class="question-mark">?</span>))
}
}
<span class="kw">impl</span>&lt;Left: BinarySerializable + FixedSize, Right: BinarySerializable + FixedSize&gt; FixedSize
<span class="kw">for </span>(Left, Right)
{
<span class="kw">const </span>SIZE_IN_BYTES: usize = Left::SIZE_IN_BYTES + Right::SIZE_IN_BYTES;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>u32 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_u32::&lt;Endianness&gt;(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;u32&gt; {
reader.read_u32::&lt;Endianness&gt;()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>u32 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">4</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>u16 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_u16::&lt;Endianness&gt;(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;u16&gt; {
reader.read_u16::&lt;Endianness&gt;()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>u16 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">2</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>u64 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_u64::&lt;Endianness&gt;(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
reader.read_u64::&lt;Endianness&gt;()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>u64 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">8</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>u128 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_u128::&lt;Endianness&gt;(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
reader.read_u128::&lt;Endianness&gt;()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>u128 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">16</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>f32 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_f32::&lt;Endianness&gt;(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
reader.read_f32::&lt;Endianness&gt;()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>f32 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">4</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>i64 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_i64::&lt;Endianness&gt;(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
reader.read_i64::&lt;Endianness&gt;()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>i64 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">8</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>f64 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_f64::&lt;Endianness&gt;(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
reader.read_f64::&lt;Endianness&gt;()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>f64 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">8</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>u8 {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_u8(<span class="kw-2">*</span><span class="self">self</span>)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;u8&gt; {
reader.read_u8()
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>u8 {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">1</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>bool {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
writer.write_u8(u8::from(<span class="kw-2">*</span><span class="self">self</span>))
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;bool&gt; {
<span class="kw">let </span>val = reader.read_u8()<span class="question-mark">?</span>;
<span class="kw">match </span>val {
<span class="number">0 </span>=&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">false</span>),
<span class="number">1 </span>=&gt; <span class="prelude-val">Ok</span>(<span class="bool-val">true</span>),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::InvalidData,
<span class="string">&quot;invalid bool value on deserialization, data corrupted&quot;</span>,
)),
}
}
}
<span class="kw">impl </span>FixedSize <span class="kw">for </span>bool {
<span class="kw">const </span>SIZE_IN_BYTES: usize = <span class="number">1</span>;
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>String {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>data: <span class="kw-2">&amp;</span>[u8] = <span class="self">self</span>.as_bytes();
VInt(data.len() <span class="kw">as </span>u64).serialize(writer)<span class="question-mark">?</span>;
writer.write_all(data)
}
<span class="kw">fn </span>deserialize&lt;R: Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;String&gt; {
<span class="kw">let </span>string_length = VInt::deserialize(reader)<span class="question-mark">?</span>.val() <span class="kw">as </span>usize;
<span class="kw">let </span><span class="kw-2">mut </span>result = String::with_capacity(string_length);
reader
.take(string_length <span class="kw">as </span>u64)
.read_to_string(<span class="kw-2">&amp;mut </span>result)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(result)
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">pub mod </span>test {
<span class="kw">use super</span>::{VInt, <span class="kw-2">*</span>};
<span class="kw">use </span><span class="kw">crate</span>::serialize::BinarySerializable;
<span class="kw">pub fn </span>fixed_size_test&lt;O: BinarySerializable + FixedSize + Default&gt;() {
<span class="kw">let </span><span class="kw-2">mut </span>buffer = Vec::new();
O::default().serialize(<span class="kw-2">&amp;mut </span>buffer).unwrap();
<span class="macro">assert_eq!</span>(buffer.len(), O::SIZE_IN_BYTES);
}
<span class="kw">fn </span>serialize_test&lt;T: BinarySerializable + Eq&gt;(v: T) -&gt; usize {
<span class="kw">let </span><span class="kw-2">mut </span>buffer: Vec&lt;u8&gt; = Vec::new();
v.serialize(<span class="kw-2">&amp;mut </span>buffer).unwrap();
<span class="kw">let </span>num_bytes = buffer.len();
<span class="kw">let </span><span class="kw-2">mut </span>cursor = <span class="kw-2">&amp;</span>buffer[..];
<span class="kw">let </span>deser = T::deserialize(<span class="kw-2">&amp;mut </span>cursor).unwrap();
<span class="macro">assert_eq!</span>(deser, v);
num_bytes
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_u8() {
fixed_size_test::&lt;u8&gt;();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_u32() {
fixed_size_test::&lt;u32&gt;();
<span class="macro">assert_eq!</span>(<span class="number">4</span>, serialize_test(<span class="number">3u32</span>));
<span class="macro">assert_eq!</span>(<span class="number">4</span>, serialize_test(<span class="number">5u32</span>));
<span class="macro">assert_eq!</span>(<span class="number">4</span>, serialize_test(u32::MAX));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_i64() {
fixed_size_test::&lt;i64&gt;();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_f64() {
fixed_size_test::&lt;f64&gt;();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_u64() {
fixed_size_test::&lt;u64&gt;();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_bool() {
fixed_size_test::&lt;bool&gt;();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_string() {
<span class="macro">assert_eq!</span>(serialize_test(String::from(<span class="string">&quot;&quot;</span>)), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(serialize_test(String::from(<span class="string">&quot;ぽよぽよ&quot;</span>)), <span class="number">1 </span>+ <span class="number">3 </span>* <span class="number">4</span>);
<span class="macro">assert_eq!</span>(serialize_test(String::from(<span class="string">&quot;富士さん見える。&quot;</span>)), <span class="number">1 </span>+ <span class="number">3 </span>* <span class="number">8</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_vec() {
<span class="macro">assert_eq!</span>(serialize_test(Vec::&lt;u8&gt;::new()), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(serialize_test(<span class="macro">vec!</span>[<span class="number">1u32</span>, <span class="number">3u32</span>]), <span class="number">1 </span>+ <span class="number">4 </span>* <span class="number">2</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_vint() {
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10_000 </span>{
serialize_test(VInt(i <span class="kw">as </span>u64));
}
<span class="macro">assert_eq!</span>(serialize_test(VInt(<span class="number">7u64</span>)), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(serialize_test(VInt(<span class="number">127u64</span>)), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(serialize_test(VInt(<span class="number">128u64</span>)), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(serialize_test(VInt(<span class="number">129u64</span>)), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(serialize_test(VInt(<span class="number">1234u64</span>)), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(serialize_test(VInt(<span class="number">16_383u64</span>)), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(serialize_test(VInt(<span class="number">16_384u64</span>)), <span class="number">3</span>);
<span class="macro">assert_eq!</span>(serialize_test(VInt(u64::MAX)), <span class="number">10</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy_common" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>