blob: 7225d29571f5a364c8795505b1e5d6fd9efa6400 [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/src/schema/value.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>value.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/index.html"><div class="logo-container">
<img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tantivy/index.html">
<img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" 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>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::net::Ipv6Addr;
<span class="kw">use </span>serde::de::Visitor;
<span class="kw">use </span>serde::{Deserialize, Deserializer, Serialize, Serializer};
<span class="kw">use </span>serde_json::Map;
<span class="kw">use </span><span class="kw">crate</span>::schema::Facet;
<span class="kw">use </span><span class="kw">crate</span>::tokenizer::PreTokenizedString;
<span class="kw">use </span><span class="kw">crate</span>::DateTime;
<span class="doccomment">/// Value represents the value of a any field.
/// It is an enum over all over all of the possible field type.
</span><span class="attribute">#[derive(Debug, Clone, PartialEq)]
</span><span class="kw">pub enum </span>Value {
<span class="doccomment">/// The str type is used for any text information.
</span>Str(String),
<span class="doccomment">/// Pre-tokenized str type,
</span>PreTokStr(PreTokenizedString),
<span class="doccomment">/// Unsigned 64-bits Integer `u64`
</span>U64(u64),
<span class="doccomment">/// Signed 64-bits Integer `i64`
</span>I64(i64),
<span class="doccomment">/// 64-bits Float `f64`
</span>F64(f64),
<span class="doccomment">/// Bool value
</span>Bool(bool),
<span class="doccomment">/// Date/time with microseconds precision
</span>Date(DateTime),
<span class="doccomment">/// Facet
</span>Facet(Facet),
<span class="doccomment">/// Arbitrarily sized byte array
</span>Bytes(Vec&lt;u8&gt;),
<span class="doccomment">/// Json object value.
</span>JsonObject(serde_json::Map&lt;String, serde_json::Value&gt;),
<span class="doccomment">/// IpV6 Address. Internally there is no IpV4, it needs to be converted to `Ipv6Addr`.
</span>IpAddr(Ipv6Addr),
}
<span class="kw">impl </span>Eq <span class="kw">for </span>Value {}
<span class="kw">impl </span>Serialize <span class="kw">for </span>Value {
<span class="kw">fn </span>serialize&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt;
<span class="kw">where </span>S: Serializer {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Value::Str(<span class="kw-2">ref </span>v) =&gt; serializer.serialize_str(v),
Value::PreTokStr(<span class="kw-2">ref </span>v) =&gt; v.serialize(serializer),
Value::U64(u) =&gt; serializer.serialize_u64(u),
Value::I64(u) =&gt; serializer.serialize_i64(u),
Value::F64(u) =&gt; serializer.serialize_f64(u),
Value::Bool(b) =&gt; serializer.serialize_bool(b),
Value::Date(<span class="kw-2">ref </span>date) =&gt; time::serde::rfc3339::serialize(<span class="kw-2">&amp;</span>date.into_utc(), serializer),
Value::Facet(<span class="kw-2">ref </span>facet) =&gt; facet.serialize(serializer),
Value::Bytes(<span class="kw-2">ref </span>bytes) =&gt; serializer.serialize_str(<span class="kw-2">&amp;</span>base64::encode(bytes)),
Value::JsonObject(<span class="kw-2">ref </span>obj) =&gt; obj.serialize(serializer),
Value::IpAddr(<span class="kw-2">ref </span>obj) =&gt; {
<span class="comment">// Ensure IpV4 addresses get serialized as IpV4, but excluding IpV6 loopback.
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(ip_v4) = obj.to_ipv4_mapped() {
ip_v4.serialize(serializer)
} <span class="kw">else </span>{
obj.serialize(serializer)
}
}
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;de</span>&gt; Deserialize&lt;<span class="lifetime">&#39;de</span>&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>deserialize&lt;D&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt;
<span class="kw">where </span>D: Deserializer&lt;<span class="lifetime">&#39;de</span>&gt; {
<span class="kw">struct </span>ValueVisitor;
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;de</span>&gt; Visitor&lt;<span class="lifetime">&#39;de</span>&gt; <span class="kw">for </span>ValueVisitor {
<span class="kw">type </span>Value = Value;
<span class="kw">fn </span>expecting(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
formatter.write_str(<span class="string">&quot;a string or u32&quot;</span>)
}
<span class="kw">fn </span>visit_i64&lt;E&gt;(<span class="self">self</span>, v: i64) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, E&gt; {
<span class="prelude-val">Ok</span>(Value::I64(v))
}
<span class="kw">fn </span>visit_u64&lt;E&gt;(<span class="self">self</span>, v: u64) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, E&gt; {
<span class="prelude-val">Ok</span>(Value::U64(v))
}
<span class="kw">fn </span>visit_f64&lt;E&gt;(<span class="self">self</span>, v: f64) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, E&gt; {
<span class="prelude-val">Ok</span>(Value::F64(v))
}
<span class="kw">fn </span>visit_bool&lt;E&gt;(<span class="self">self</span>, v: bool) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, E&gt; {
<span class="prelude-val">Ok</span>(Value::Bool(v))
}
<span class="kw">fn </span>visit_str&lt;E&gt;(<span class="self">self</span>, v: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, E&gt; {
<span class="prelude-val">Ok</span>(Value::Str(v.to_owned()))
}
<span class="kw">fn </span>visit_string&lt;E&gt;(<span class="self">self</span>, v: String) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, E&gt; {
<span class="prelude-val">Ok</span>(Value::Str(v))
}
}
deserializer.deserialize_any(ValueVisitor)
}
}
<span class="kw">impl </span>Value {
<span class="doccomment">/// Returns the text value, provided the value is of the `Str` type.
/// (Returns `None` if the value is not of the `Str` type).
</span><span class="kw">pub fn </span>as_text(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt; {
<span class="kw">if let </span>Value::Str(text) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(text)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the facet value, provided the value is of the `Facet` type.
/// (Returns `None` if the value is not of the `Facet` type).
</span><span class="kw">pub fn </span>as_facet(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Facet&gt; {
<span class="kw">if let </span>Value::Facet(facet) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(facet)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the tokenized text, provided the value is of the `PreTokStr` type.
/// (Returns `None` if the value is not of the `PreTokStr` type.)
</span><span class="kw">pub fn </span>tokenized_text(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>PreTokenizedString&gt; {
<span class="kw">if let </span>Value::PreTokStr(tokenized_text) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(tokenized_text)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the u64-value, provided the value is of the `U64` type.
/// (Returns `None` if the value is not of the `U64` type)
</span><span class="kw">pub fn </span>as_u64(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;u64&gt; {
<span class="kw">if let </span>Value::U64(val) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(<span class="kw-2">*</span>val)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the i64-value, provided the value is of the `I64` type.
///
/// Returns `None` if the value is not of type `I64`.
</span><span class="kw">pub fn </span>as_i64(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;i64&gt; {
<span class="kw">if let </span>Value::I64(val) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(<span class="kw-2">*</span>val)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the f64-value, provided the value is of the `F64` type.
///
/// Returns `None` if the value is not of type `F64`.
</span><span class="kw">pub fn </span>as_f64(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;f64&gt; {
<span class="kw">if let </span>Value::F64(value) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(<span class="kw-2">*</span>value)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the bool value, provided the value is of the `Bool` type.
///
/// Returns `None` if the value is not of type `Bool`.
</span><span class="kw">pub fn </span>as_bool(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;bool&gt; {
<span class="kw">if let </span>Value::Bool(value) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(<span class="kw-2">*</span>value)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the Date-value, provided the value is of the `Date` type.
///
/// Returns `None` if the value is not of type `Date`.
</span><span class="kw">pub fn </span>as_date(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;DateTime&gt; {
<span class="kw">if let </span>Value::Date(date) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(<span class="kw-2">*</span>date)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the Bytes-value, provided the value is of the `Bytes` type.
///
/// Returns `None` if the value is not of type `Bytes`.
</span><span class="kw">pub fn </span>as_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>[u8]&gt; {
<span class="kw">if let </span>Value::Bytes(bytes) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(bytes)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the json object, provided the value is of the `JsonObject` type.
///
/// Returns `None` if the value is not of type `JsonObject`.
</span><span class="kw">pub fn </span>as_json(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>Map&lt;String, serde_json::Value&gt;&gt; {
<span class="kw">if let </span>Value::JsonObject(json) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(json)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Returns the ip addr, provided the value is of the `Ip` type.
/// (Returns None if the value is not of the `Ip` type)
</span><span class="kw">pub fn </span>as_ip_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Ipv6Addr&gt; {
<span class="kw">if let </span>Value::IpAddr(val) = <span class="self">self </span>{
<span class="prelude-val">Some</span>(<span class="kw-2">*</span>val)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
}
<span class="kw">impl </span>From&lt;String&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(s: String) -&gt; Value {
Value::Str(s)
}
}
<span class="kw">impl </span>From&lt;Ipv6Addr&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(v: Ipv6Addr) -&gt; Value {
Value::IpAddr(v)
}
}
<span class="kw">impl </span>From&lt;u64&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(v: u64) -&gt; Value {
Value::U64(v)
}
}
<span class="kw">impl </span>From&lt;i64&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(v: i64) -&gt; Value {
Value::I64(v)
}
}
<span class="kw">impl </span>From&lt;f64&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(v: f64) -&gt; Value {
Value::F64(v)
}
}
<span class="kw">impl </span>From&lt;bool&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(b: bool) -&gt; <span class="self">Self </span>{
Value::Bool(b)
}
}
<span class="kw">impl </span>From&lt;DateTime&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(dt: DateTime) -&gt; Value {
Value::Date(dt)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; From&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(s: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str) -&gt; Value {
Value::Str(s.to_string())
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; From&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8]&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(bytes: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8]) -&gt; Value {
Value::Bytes(bytes.to_vec())
}
}
<span class="kw">impl </span>From&lt;Facet&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(facet: Facet) -&gt; Value {
Value::Facet(facet)
}
}
<span class="kw">impl </span>From&lt;Vec&lt;u8&gt;&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(bytes: Vec&lt;u8&gt;) -&gt; Value {
Value::Bytes(bytes)
}
}
<span class="kw">impl </span>From&lt;PreTokenizedString&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(pretokenized_string: PreTokenizedString) -&gt; Value {
Value::PreTokStr(pretokenized_string)
}
}
<span class="kw">impl </span>From&lt;serde_json::Map&lt;String, serde_json::Value&gt;&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(json_object: serde_json::Map&lt;String, serde_json::Value&gt;) -&gt; Value {
Value::JsonObject(json_object)
}
}
<span class="kw">impl </span>From&lt;serde_json::Value&gt; <span class="kw">for </span>Value {
<span class="kw">fn </span>from(json_value: serde_json::Value) -&gt; Value {
<span class="kw">match </span>json_value {
serde_json::Value::Object(json_object) =&gt; Value::JsonObject(json_object),
<span class="kw">_ </span>=&gt; {
<span class="macro">panic!</span>(<span class="string">&quot;Expected a json object.&quot;</span>);
}
}
}
}
<span class="kw">mod </span>binary_serialize {
<span class="kw">use </span>std::io::{<span class="self">self</span>, Read, Write};
<span class="kw">use </span>std::net::Ipv6Addr;
<span class="kw">use </span>common::{f64_to_u64, u64_to_f64, BinarySerializable};
<span class="kw">use </span>fastfield_codecs::MonotonicallyMappableToU128;
<span class="kw">use </span><span class="kw">super</span>::Value;
<span class="kw">use </span><span class="kw">crate</span>::schema::Facet;
<span class="kw">use </span><span class="kw">crate</span>::tokenizer::PreTokenizedString;
<span class="kw">use </span><span class="kw">crate</span>::DateTime;
<span class="kw">const </span>TEXT_CODE: u8 = <span class="number">0</span>;
<span class="kw">const </span>U64_CODE: u8 = <span class="number">1</span>;
<span class="kw">const </span>I64_CODE: u8 = <span class="number">2</span>;
<span class="kw">const </span>HIERARCHICAL_FACET_CODE: u8 = <span class="number">3</span>;
<span class="kw">const </span>BYTES_CODE: u8 = <span class="number">4</span>;
<span class="kw">const </span>DATE_CODE: u8 = <span class="number">5</span>;
<span class="kw">const </span>F64_CODE: u8 = <span class="number">6</span>;
<span class="kw">const </span>EXT_CODE: u8 = <span class="number">7</span>;
<span class="kw">const </span>JSON_OBJ_CODE: u8 = <span class="number">8</span>;
<span class="kw">const </span>BOOL_CODE: u8 = <span class="number">9</span>;
<span class="kw">const </span>IP_CODE: u8 = <span class="number">10</span>;
<span class="comment">// extended types
</span><span class="kw">const </span>TOK_STR_CODE: u8 = <span class="number">0</span>;
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>Value {
<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">match </span><span class="kw-2">*</span><span class="self">self </span>{
Value::Str(<span class="kw-2">ref </span>text) =&gt; {
TEXT_CODE.serialize(writer)<span class="question-mark">?</span>;
text.serialize(writer)
}
Value::PreTokStr(<span class="kw-2">ref </span>tok_str) =&gt; {
EXT_CODE.serialize(writer)<span class="question-mark">?</span>;
TOK_STR_CODE.serialize(writer)<span class="question-mark">?</span>;
<span class="kw">if let </span><span class="prelude-val">Ok</span>(text) = serde_json::to_string(tok_str) {
text.serialize(writer)
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::Other,
<span class="string">&quot;Failed to dump Value::PreTokStr(_) to json.&quot;</span>,
))
}
}
Value::U64(<span class="kw-2">ref </span>val) =&gt; {
U64_CODE.serialize(writer)<span class="question-mark">?</span>;
val.serialize(writer)
}
Value::I64(<span class="kw-2">ref </span>val) =&gt; {
I64_CODE.serialize(writer)<span class="question-mark">?</span>;
val.serialize(writer)
}
Value::F64(<span class="kw-2">ref </span>val) =&gt; {
F64_CODE.serialize(writer)<span class="question-mark">?</span>;
f64_to_u64(<span class="kw-2">*</span>val).serialize(writer)
}
Value::Bool(<span class="kw-2">ref </span>val) =&gt; {
BOOL_CODE.serialize(writer)<span class="question-mark">?</span>;
val.serialize(writer)
}
Value::Date(<span class="kw-2">ref </span>val) =&gt; {
DATE_CODE.serialize(writer)<span class="question-mark">?</span>;
<span class="kw">let </span>DateTime {
timestamp_micros, ..
} = val;
timestamp_micros.serialize(writer)
}
Value::Facet(<span class="kw-2">ref </span>facet) =&gt; {
HIERARCHICAL_FACET_CODE.serialize(writer)<span class="question-mark">?</span>;
facet.serialize(writer)
}
Value::Bytes(<span class="kw-2">ref </span>bytes) =&gt; {
BYTES_CODE.serialize(writer)<span class="question-mark">?</span>;
bytes.serialize(writer)
}
Value::JsonObject(<span class="kw-2">ref </span>map) =&gt; {
JSON_OBJ_CODE.serialize(writer)<span class="question-mark">?</span>;
serde_json::to_writer(writer, <span class="kw-2">&amp;</span>map)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
Value::IpAddr(<span class="kw-2">ref </span>ip) =&gt; {
IP_CODE.serialize(writer)<span class="question-mark">?</span>;
ip.to_u128().serialize(writer)
}
}
}
<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">let </span>type_code = u8::deserialize(reader)<span class="question-mark">?</span>;
<span class="kw">match </span>type_code {
TEXT_CODE =&gt; {
<span class="kw">let </span>text = String::deserialize(reader)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value::Str(text))
}
U64_CODE =&gt; {
<span class="kw">let </span>value = u64::deserialize(reader)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value::U64(value))
}
I64_CODE =&gt; {
<span class="kw">let </span>value = i64::deserialize(reader)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value::I64(value))
}
F64_CODE =&gt; {
<span class="kw">let </span>value = u64_to_f64(u64::deserialize(reader)<span class="question-mark">?</span>);
<span class="prelude-val">Ok</span>(Value::F64(value))
}
BOOL_CODE =&gt; {
<span class="kw">let </span>value = bool::deserialize(reader)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value::Bool(value))
}
DATE_CODE =&gt; {
<span class="kw">let </span>timestamp_micros = i64::deserialize(reader)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value::Date(DateTime::from_timestamp_micros(
timestamp_micros,
)))
}
HIERARCHICAL_FACET_CODE =&gt; <span class="prelude-val">Ok</span>(Value::Facet(Facet::deserialize(reader)<span class="question-mark">?</span>)),
BYTES_CODE =&gt; <span class="prelude-val">Ok</span>(Value::Bytes(Vec::&lt;u8&gt;::deserialize(reader)<span class="question-mark">?</span>)),
EXT_CODE =&gt; {
<span class="kw">let </span>ext_type_code = u8::deserialize(reader)<span class="question-mark">?</span>;
<span class="kw">match </span>ext_type_code {
TOK_STR_CODE =&gt; {
<span class="kw">let </span>str_val = String::deserialize(reader)<span class="question-mark">?</span>;
<span class="kw">if let </span><span class="prelude-val">Ok</span>(value) = serde_json::from_str::&lt;PreTokenizedString&gt;(<span class="kw-2">&amp;</span>str_val)
{
<span class="prelude-val">Ok</span>(Value::PreTokStr(value))
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::Other,
<span class="string">&quot;Failed to parse string data as Value::PreTokStr(_).&quot;</span>,
))
}
}
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::InvalidData,
<span class="macro">format!</span>(
<span class="string">&quot;No extended field type is associated with code {:?}&quot;</span>,
ext_type_code
),
)),
}
}
JSON_OBJ_CODE =&gt; {
<span class="comment">// As explained in
// https://docs.serde.rs/serde_json/fn.from_reader.html
//
// `T::from_reader(..)` expects EOF after reading the object,
// which is not what we want here.
//
// For this reason we need to create our own `Deserializer`.
</span><span class="kw">let </span><span class="kw-2">mut </span>de = serde_json::Deserializer::from_reader(reader);
<span class="kw">let </span>json_map = &lt;serde_json::Map::&lt;String, serde_json::Value&gt; <span class="kw">as </span>serde::Deserialize&gt;::deserialize(<span class="kw-2">&amp;mut </span>de)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value::JsonObject(json_map))
}
IP_CODE =&gt; {
<span class="kw">let </span>value = u128::deserialize(reader)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Value::IpAddr(Ipv6Addr::from_u128(value)))
}
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(io::Error::new(
io::ErrorKind::InvalidData,
<span class="macro">format!</span>(<span class="string">&quot;No field type is associated with code {:?}&quot;</span>, type_code),
)),
}
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::Value;
<span class="kw">use </span><span class="kw">crate</span>::schema::{BytesOptions, Schema};
<span class="kw">use </span><span class="kw">crate</span>::time::format_description::well_known::Rfc3339;
<span class="kw">use </span><span class="kw">crate</span>::time::OffsetDateTime;
<span class="kw">use crate</span>::{DateTime, Document};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_parse_bytes_doc() {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>bytes_options = BytesOptions::default();
<span class="kw">let </span>bytes_field = schema_builder.add_bytes_field(<span class="string">&quot;my_bytes&quot;</span>, bytes_options);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span><span class="kw-2">mut </span>doc = Document::default();
doc.add_bytes(bytes_field, <span class="string">&quot;this is a test&quot;</span>.as_bytes());
<span class="kw">let </span>json_string = schema.to_json(<span class="kw-2">&amp;</span>doc);
<span class="macro">assert_eq!</span>(json_string, <span class="string">r#&quot;{&quot;my_bytes&quot;:[&quot;dGhpcyBpcyBhIHRlc3Q=&quot;]}&quot;#</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_parse_empty_bytes_doc() {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>bytes_options = BytesOptions::default();
<span class="kw">let </span>bytes_field = schema_builder.add_bytes_field(<span class="string">&quot;my_bytes&quot;</span>, bytes_options);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span><span class="kw-2">mut </span>doc = Document::default();
doc.add_bytes(bytes_field, <span class="string">&quot;&quot;</span>.as_bytes());
<span class="kw">let </span>json_string = schema.to_json(<span class="kw-2">&amp;</span>doc);
<span class="macro">assert_eq!</span>(json_string, <span class="string">r#&quot;{&quot;my_bytes&quot;:[&quot;&quot;]}&quot;#</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_parse_many_bytes_doc() {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>bytes_options = BytesOptions::default();
<span class="kw">let </span>bytes_field = schema_builder.add_bytes_field(<span class="string">&quot;my_bytes&quot;</span>, bytes_options);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span><span class="kw-2">mut </span>doc = Document::default();
doc.add_bytes(
bytes_field,
<span class="string">&quot;A bigger test I guess\nspanning on multiple lines\nhoping this will work&quot;</span>.as_bytes(),
);
<span class="kw">let </span>json_string = schema.to_json(<span class="kw-2">&amp;</span>doc);
<span class="macro">assert_eq!</span>(
json_string,
<span class="string">r#&quot;{&quot;my_bytes&quot;:[&quot;QSBiaWdnZXIgdGVzdCBJIGd1ZXNzCnNwYW5uaW5nIG9uIG11bHRpcGxlIGxpbmVzCmhvcGluZyB0aGlzIHdpbGwgd29yaw==&quot;]}&quot;#
</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serialize_date() {
<span class="kw">let </span>value = Value::from(DateTime::from_utc(
OffsetDateTime::parse(<span class="string">&quot;1996-12-20T00:39:57+00:00&quot;</span>, <span class="kw-2">&amp;</span>Rfc3339).unwrap(),
));
<span class="kw">let </span>serialized_value_json = serde_json::to_string_pretty(<span class="kw-2">&amp;</span>value).unwrap();
<span class="macro">assert_eq!</span>(serialized_value_json, <span class="string">r#&quot;&quot;1996-12-20T00:39:57Z&quot;&quot;#</span>);
<span class="kw">let </span>value = Value::from(DateTime::from_utc(
OffsetDateTime::parse(<span class="string">&quot;1996-12-20T00:39:57-01:00&quot;</span>, <span class="kw-2">&amp;</span>Rfc3339).unwrap(),
));
<span class="kw">let </span>serialized_value_json = serde_json::to_string_pretty(<span class="kw-2">&amp;</span>value).unwrap();
<span class="comment">// The time zone information gets lost by conversion into `Value::Date` and
// implicitly becomes UTC.
</span><span class="macro">assert_eq!</span>(serialized_value_json, <span class="string">r#&quot;&quot;1996-12-20T01:39:57Z&quot;&quot;#</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>