| <!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/term.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>term.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::convert::TryInto; |
| <span class="kw">use </span>std::hash::{Hash, Hasher}; |
| <span class="kw">use </span>std::net::Ipv6Addr; |
| <span class="kw">use </span>std::{fmt, str}; |
| |
| <span class="kw">use </span>fastfield_codecs::MonotonicallyMappableToU128; |
| |
| <span class="kw">use </span><span class="kw">super</span>::Field; |
| <span class="kw">use </span><span class="kw">crate</span>::fastfield::FastValue; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{Facet, Type}; |
| <span class="kw">use crate</span>::{DatePrecision, DateTime}; |
| |
| <span class="doccomment">/// Separates the different segments of |
| /// the json path. |
| </span><span class="kw">pub const </span>JSON_PATH_SEGMENT_SEP: u8 = <span class="number">1u8</span>; |
| <span class="kw">pub const </span>JSON_PATH_SEGMENT_SEP_STR: <span class="kw-2">&</span>str = |
| <span class="kw">unsafe </span>{ std::str::from_utf8_unchecked(<span class="kw-2">&</span>[JSON_PATH_SEGMENT_SEP]) }; |
| |
| <span class="doccomment">/// Separates the json path and the value in |
| /// a JSON term binary representation. |
| </span><span class="kw">pub const </span>JSON_END_OF_PATH: u8 = <span class="number">0u8</span>; |
| |
| <span class="doccomment">/// Term represents the value that the token can take. |
| /// |
| /// It actually wraps a `Vec<u8>`. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>Term<B = Vec<u8>>(B) |
| <span class="kw">where </span>B: AsRef<[u8]>; |
| |
| <span class="doccomment">/// The number of bytes used as metadata by `Term`. |
| </span><span class="kw">const </span>TERM_METADATA_LENGTH: usize = <span class="number">5</span>; |
| |
| <span class="kw">impl </span>Term { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>with_capacity(capacity: usize) -> Term { |
| <span class="kw">let </span><span class="kw-2">mut </span>data = Vec::with_capacity(TERM_METADATA_LENGTH + capacity); |
| data.resize(TERM_METADATA_LENGTH, <span class="number">0u8</span>); |
| Term(data) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>with_type_and_field(typ: Type, field: Field) -> Term { |
| <span class="kw">let </span><span class="kw-2">mut </span>term = <span class="self">Self</span>::with_capacity(<span class="number">8</span>); |
| term.set_field_and_type(field, typ); |
| term |
| } |
| |
| <span class="kw">fn </span>with_bytes_and_field_and_payload(typ: Type, field: Field, bytes: <span class="kw-2">&</span>[u8]) -> Term { |
| <span class="kw">let </span><span class="kw-2">mut </span>term = <span class="self">Self</span>::with_capacity(bytes.len()); |
| term.set_field_and_type(field, typ); |
| term.<span class="number">0</span>.extend_from_slice(bytes); |
| term |
| } |
| |
| <span class="kw">fn </span>from_fast_value<T: FastValue>(field: Field, val: <span class="kw-2">&</span>T) -> Term { |
| <span class="kw">let </span><span class="kw-2">mut </span>term = <span class="self">Self</span>::with_type_and_field(T::to_type(), field); |
| term.set_u64(val.to_u64()); |
| term |
| } |
| |
| <span class="doccomment">/// Panics when the term is not empty... ie: some value is set. |
| /// Use `clear_with_field_and_type` in that case. |
| /// |
| /// Sets field and the type. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>set_field_and_type(<span class="kw-2">&mut </span><span class="self">self</span>, field: Field, typ: Type) { |
| <span class="macro">assert!</span>(<span class="self">self</span>.is_empty()); |
| <span class="self">self</span>.<span class="number">0</span>[<span class="number">0</span>..<span class="number">4</span>].clone_from_slice(field.field_id().to_be_bytes().as_ref()); |
| <span class="self">self</span>.<span class="number">0</span>[<span class="number">4</span>] = typ.to_code(); |
| } |
| |
| <span class="doccomment">/// Is empty if there are no value bytes. |
| </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.<span class="number">0</span>.len() == TERM_METADATA_LENGTH |
| } |
| |
| <span class="doccomment">/// Builds a term given a field, and a `Ipv6Addr`-value |
| </span><span class="kw">pub fn </span>from_field_ip_addr(field: Field, ip_addr: Ipv6Addr) -> Term { |
| <span class="kw">let </span><span class="kw-2">mut </span>term = <span class="self">Self</span>::with_type_and_field(Type::IpAddr, field); |
| term.set_ip_addr(ip_addr); |
| term |
| } |
| |
| <span class="doccomment">/// Builds a term given a field, and a `u64`-value |
| </span><span class="kw">pub fn </span>from_field_u64(field: Field, val: u64) -> Term { |
| Term::from_fast_value(field, <span class="kw-2">&</span>val) |
| } |
| |
| <span class="doccomment">/// Builds a term given a field, and a `i64`-value |
| </span><span class="kw">pub fn </span>from_field_i64(field: Field, val: i64) -> Term { |
| Term::from_fast_value(field, <span class="kw-2">&</span>val) |
| } |
| |
| <span class="doccomment">/// Builds a term given a field, and a `f64`-value |
| </span><span class="kw">pub fn </span>from_field_f64(field: Field, val: f64) -> Term { |
| Term::from_fast_value(field, <span class="kw-2">&</span>val) |
| } |
| |
| <span class="doccomment">/// Builds a term given a field, and a `bool`-value |
| </span><span class="kw">pub fn </span>from_field_bool(field: Field, val: bool) -> Term { |
| Term::from_fast_value(field, <span class="kw-2">&</span>val) |
| } |
| |
| <span class="doccomment">/// Builds a term given a field, and a `DateTime` value |
| </span><span class="kw">pub fn </span>from_field_date(field: Field, val: DateTime) -> Term { |
| Term::from_fast_value(field, <span class="kw-2">&</span>val.truncate(DatePrecision::Seconds)) |
| } |
| |
| <span class="doccomment">/// Creates a `Term` given a facet. |
| </span><span class="kw">pub fn </span>from_facet(field: Field, facet: <span class="kw-2">&</span>Facet) -> Term { |
| <span class="kw">let </span>facet_encoded_str = facet.encoded_str(); |
| Term::with_bytes_and_field_and_payload(Type::Facet, field, facet_encoded_str.as_bytes()) |
| } |
| |
| <span class="doccomment">/// Builds a term given a field, and a string value |
| </span><span class="kw">pub fn </span>from_field_text(field: Field, text: <span class="kw-2">&</span>str) -> Term { |
| Term::with_bytes_and_field_and_payload(Type::Str, field, text.as_bytes()) |
| } |
| |
| <span class="doccomment">/// Builds a term bytes. |
| </span><span class="kw">pub fn </span>from_field_bytes(field: Field, bytes: <span class="kw-2">&</span>[u8]) -> Term { |
| Term::with_bytes_and_field_and_payload(Type::Bytes, field, bytes) |
| } |
| |
| <span class="doccomment">/// Removes the value_bytes and set the field and type code. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>clear_with_field_and_type(<span class="kw-2">&mut </span><span class="self">self</span>, typ: Type, field: Field) { |
| <span class="self">self</span>.truncate_value_bytes(<span class="number">0</span>); |
| <span class="self">self</span>.set_field_and_type(field, typ); |
| } |
| |
| <span class="doccomment">/// Removes the value_bytes and set the type code. |
| </span><span class="kw">pub fn </span>clear_with_type(<span class="kw-2">&mut </span><span class="self">self</span>, typ: Type) { |
| <span class="self">self</span>.truncate_value_bytes(<span class="number">0</span>); |
| <span class="self">self</span>.<span class="number">0</span>[<span class="number">4</span>] = typ.to_code(); |
| } |
| |
| <span class="doccomment">/// Sets a u64 value in the term. |
| /// |
| /// U64 are serialized using (8-byte) BigEndian |
| /// representation. |
| /// The use of BigEndian has the benefit of preserving |
| /// the natural order of the values. |
| </span><span class="kw">pub fn </span>set_u64(<span class="kw-2">&mut </span><span class="self">self</span>, val: u64) { |
| <span class="self">self</span>.set_fast_value(val); |
| } |
| |
| <span class="doccomment">/// Sets a `i64` value in the term. |
| </span><span class="kw">pub fn </span>set_i64(<span class="kw-2">&mut </span><span class="self">self</span>, val: i64) { |
| <span class="self">self</span>.set_fast_value(val); |
| } |
| |
| <span class="doccomment">/// Sets a `DateTime` value in the term. |
| </span><span class="kw">pub fn </span>set_date(<span class="kw-2">&mut </span><span class="self">self</span>, date: DateTime) { |
| <span class="self">self</span>.set_fast_value(date); |
| } |
| |
| <span class="doccomment">/// Sets a `f64` value in the term. |
| </span><span class="kw">pub fn </span>set_f64(<span class="kw-2">&mut </span><span class="self">self</span>, val: f64) { |
| <span class="self">self</span>.set_fast_value(val); |
| } |
| |
| <span class="doccomment">/// Sets a `bool` value in the term. |
| </span><span class="kw">pub fn </span>set_bool(<span class="kw-2">&mut </span><span class="self">self</span>, val: bool) { |
| <span class="self">self</span>.set_fast_value(val); |
| } |
| |
| <span class="kw">fn </span>set_fast_value<T: FastValue>(<span class="kw-2">&mut </span><span class="self">self</span>, val: T) { |
| <span class="self">self</span>.set_bytes(val.to_u64().to_be_bytes().as_ref()); |
| } |
| |
| <span class="doccomment">/// Sets a `Ipv6Addr` value in the term. |
| </span><span class="kw">pub fn </span>set_ip_addr(<span class="kw-2">&mut </span><span class="self">self</span>, val: Ipv6Addr) { |
| <span class="self">self</span>.set_bytes(val.to_u128().to_be_bytes().as_ref()); |
| } |
| |
| <span class="doccomment">/// Sets the value of a `Bytes` field. |
| </span><span class="kw">pub fn </span>set_bytes(<span class="kw-2">&mut </span><span class="self">self</span>, bytes: <span class="kw-2">&</span>[u8]) { |
| <span class="self">self</span>.truncate_value_bytes(<span class="number">0</span>); |
| <span class="self">self</span>.<span class="number">0</span>.extend(bytes); |
| } |
| |
| <span class="doccomment">/// Set the texts only, keeping the field untouched. |
| </span><span class="kw">pub fn </span>set_text(<span class="kw-2">&mut </span><span class="self">self</span>, text: <span class="kw-2">&</span>str) { |
| <span class="self">self</span>.set_bytes(text.as_bytes()); |
| } |
| |
| <span class="doccomment">/// Truncates the value bytes of the term. Value and field type stays the same. |
| </span><span class="kw">pub fn </span>truncate_value_bytes(<span class="kw-2">&mut </span><span class="self">self</span>, len: usize) { |
| <span class="self">self</span>.<span class="number">0</span>.truncate(len + TERM_METADATA_LENGTH); |
| } |
| |
| <span class="doccomment">/// Returns the value bytes as mutable slice |
| </span><span class="kw">pub fn </span>value_bytes_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>[u8] { |
| <span class="kw-2">&mut </span><span class="self">self</span>.<span class="number">0</span>[TERM_METADATA_LENGTH..] |
| } |
| |
| <span class="doccomment">/// The length of the bytes. |
| </span><span class="kw">pub fn </span>len_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.<span class="number">0</span>.len() - TERM_METADATA_LENGTH |
| } |
| |
| <span class="doccomment">/// Appends value bytes to the Term. |
| /// |
| /// This function returns the segment that has just been added. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>append_bytes(<span class="kw-2">&mut </span><span class="self">self</span>, bytes: <span class="kw-2">&</span>[u8]) -> <span class="kw-2">&mut </span>[u8] { |
| <span class="kw">let </span>len_before = <span class="self">self</span>.<span class="number">0</span>.len(); |
| <span class="self">self</span>.<span class="number">0</span>.extend_from_slice(bytes); |
| <span class="kw-2">&mut </span><span class="self">self</span>.<span class="number">0</span>[len_before..] |
| } |
| |
| <span class="doccomment">/// Appends a single byte to the term. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>push_byte(<span class="kw-2">&mut </span><span class="self">self</span>, byte: u8) { |
| <span class="self">self</span>.<span class="number">0</span>.push(byte); |
| } |
| } |
| |
| <span class="kw">impl</span><B> Ord <span class="kw">for </span>Term<B> |
| <span class="kw">where </span>B: AsRef<[u8]> |
| { |
| <span class="kw">fn </span>cmp(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> std::cmp::Ordering { |
| <span class="self">self</span>.as_slice().cmp(other.as_slice()) |
| } |
| } |
| |
| <span class="kw">impl</span><B> PartialOrd <span class="kw">for </span>Term<B> |
| <span class="kw">where </span>B: AsRef<[u8]> |
| { |
| <span class="kw">fn </span>partial_cmp(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> <span class="prelude-ty">Option</span><std::cmp::Ordering> { |
| <span class="prelude-val">Some</span>(<span class="self">self</span>.cmp(other)) |
| } |
| } |
| |
| <span class="kw">impl</span><B> PartialEq <span class="kw">for </span>Term<B> |
| <span class="kw">where </span>B: AsRef<[u8]> |
| { |
| <span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { |
| <span class="self">self</span>.as_slice() == other.as_slice() |
| } |
| } |
| |
| <span class="kw">impl</span><B> Eq <span class="kw">for </span>Term<B> <span class="kw">where </span>B: AsRef<[u8]> {} |
| |
| <span class="kw">impl</span><B> Hash <span class="kw">for </span>Term<B> |
| <span class="kw">where </span>B: AsRef<[u8]> |
| { |
| <span class="kw">fn </span>hash<H: Hasher>(<span class="kw-2">&</span><span class="self">self</span>, state: <span class="kw-2">&mut </span>H) { |
| <span class="self">self</span>.<span class="number">0</span>.as_ref().hash(state) |
| } |
| } |
| |
| <span class="kw">impl</span><B> Term<B> |
| <span class="kw">where </span>B: AsRef<[u8]> |
| { |
| <span class="doccomment">/// Wraps a object holding bytes |
| </span><span class="kw">pub fn </span>wrap(data: B) -> Term<B> { |
| Term(data) |
| } |
| |
| <span class="kw">fn </span>typ_code(<span class="kw-2">&</span><span class="self">self</span>) -> u8 { |
| <span class="kw-2">*</span><span class="self">self |
| </span>.as_slice() |
| .get(<span class="number">4</span>) |
| .expect(<span class="string">"the byte representation is too short"</span>) |
| } |
| |
| <span class="doccomment">/// Return the type of the term. |
| </span><span class="kw">pub fn </span>typ(<span class="kw-2">&</span><span class="self">self</span>) -> Type { |
| Type::from_code(<span class="self">self</span>.typ_code()).expect(<span class="string">"The term has an invalid type code"</span>) |
| } |
| |
| <span class="doccomment">/// Returns the field. |
| </span><span class="kw">pub fn </span>field(<span class="kw-2">&</span><span class="self">self</span>) -> Field { |
| <span class="kw">let </span><span class="kw-2">mut </span>field_id_bytes = [<span class="number">0u8</span>; <span class="number">4</span>]; |
| field_id_bytes.copy_from_slice(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.as_ref()[..<span class="number">4</span>]); |
| Field::from_field_id(u32::from_be_bytes(field_id_bytes)) |
| } |
| |
| <span class="doccomment">/// Returns the `u64` value stored in a term. |
| /// |
| /// Returns `None` if the term is not of the u64 type, or if the term byte representation |
| /// is invalid. |
| </span><span class="kw">pub fn </span>as_u64(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><u64> { |
| <span class="self">self</span>.get_fast_type::<u64>() |
| } |
| |
| <span class="kw">fn </span>get_fast_type<T: FastValue>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><T> { |
| <span class="kw">if </span><span class="self">self</span>.typ() != T::to_type() { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="kw">let </span><span class="kw-2">mut </span>value_bytes = [<span class="number">0u8</span>; <span class="number">8</span>]; |
| <span class="kw">let </span>bytes = <span class="self">self</span>.value_bytes(); |
| <span class="kw">if </span>bytes.len() != <span class="number">8 </span>{ |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| value_bytes.copy_from_slice(<span class="self">self</span>.value_bytes()); |
| <span class="kw">let </span>value_u64 = u64::from_be_bytes(value_bytes); |
| <span class="prelude-val">Some</span>(T::from_u64(value_u64)) |
| } |
| |
| <span class="doccomment">/// Returns the `i64` value stored in a term. |
| /// |
| /// Returns `None` if the term is not of the i64 type, or if the term byte representation |
| /// is invalid. |
| </span><span class="kw">pub fn </span>as_i64(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><i64> { |
| <span class="self">self</span>.get_fast_type::<i64>() |
| } |
| |
| <span class="doccomment">/// Returns the `f64` value stored in a term. |
| /// |
| /// Returns `None` if the term is not of the f64 type, or if the term byte representation |
| /// is invalid. |
| </span><span class="kw">pub fn </span>as_f64(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><f64> { |
| <span class="self">self</span>.get_fast_type::<f64>() |
| } |
| |
| <span class="doccomment">/// Returns the `bool` value stored in a term. |
| /// |
| /// Returns `None` if the term is not of the bool type, or if the term byte representation |
| /// is invalid. |
| </span><span class="kw">pub fn </span>as_bool(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><bool> { |
| <span class="self">self</span>.get_fast_type::<bool>() |
| } |
| |
| <span class="doccomment">/// Returns the `Date` value stored in a term. |
| /// |
| /// Returns `None` if the term is not of the Date type, or if the term byte representation |
| /// is invalid. |
| </span><span class="kw">pub fn </span>as_date(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><DateTime> { |
| <span class="self">self</span>.get_fast_type::<DateTime>() |
| } |
| |
| <span class="doccomment">/// Returns the text associated with the term. |
| /// |
| /// Returns `None` if the field is not of string type |
| /// or if the bytes are not valid utf-8. |
| </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { |
| <span class="kw">if </span><span class="self">self</span>.typ() != Type::Str { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| str::from_utf8(<span class="self">self</span>.value_bytes()).ok() |
| } |
| |
| <span class="doccomment">/// Returns the facet associated with the term. |
| /// |
| /// Returns `None` if the field is not of facet type |
| /// or if the bytes are not valid utf-8. |
| </span><span class="kw">pub fn </span>as_facet(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Facet> { |
| <span class="kw">if </span><span class="self">self</span>.typ() != Type::Facet { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="kw">let </span>facet_encode_str = str::from_utf8(<span class="self">self</span>.value_bytes()).ok()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(Facet::from_encoded_string(facet_encode_str.to_string())) |
| } |
| |
| <span class="doccomment">/// Returns the bytes associated with the term. |
| /// |
| /// Returns `None` if the field is not of bytes type. |
| </span><span class="kw">pub fn </span>as_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[u8]> { |
| <span class="kw">if </span><span class="self">self</span>.typ() != Type::Bytes { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| <span class="prelude-val">Some</span>(<span class="self">self</span>.value_bytes()) |
| } |
| |
| <span class="doccomment">/// Returns the serialized value of the term. |
| /// (this does not include the field.) |
| /// |
| /// If the term is a string, its value is utf-8 encoded. |
| /// If the term is a u64, its value is encoded according |
| /// to `byteorder::LittleEndian`. |
| </span><span class="kw">pub fn </span>value_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.as_ref()[TERM_METADATA_LENGTH..] |
| } |
| |
| <span class="doccomment">/// Returns the underlying `&[u8]`. |
| /// |
| /// Do NOT rely on this byte representation in the index. |
| /// This value is likely to change in the future. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_slice(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.<span class="number">0</span>.as_ref() |
| } |
| } |
| |
| <span class="kw">fn </span>write_opt<T: std::fmt::Debug>(f: <span class="kw-2">&mut </span>fmt::Formatter, val_opt: <span class="prelude-ty">Option</span><T>) -> fmt::Result { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(val) = val_opt { |
| <span class="macro">write!</span>(f, <span class="string">"{:?}"</span>, val)<span class="question-mark">?</span>; |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="kw">fn </span>as_str(value_bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { |
| std::str::from_utf8(value_bytes).ok() |
| } |
| |
| <span class="kw">fn </span>get_fast_type<T: FastValue>(bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><T> { |
| <span class="kw">let </span>value_u64 = u64::from_be_bytes(bytes.try_into().ok()<span class="question-mark">?</span>); |
| <span class="prelude-val">Some</span>(T::from_u64(value_u64)) |
| } |
| |
| <span class="doccomment">/// Returns the json path (without non-human friendly separators, the type of the value, and the |
| /// value bytes). Returns `None` if the value is not JSON or is not valid. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_json_path_type_value_bytes(bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><(<span class="kw-2">&</span>str, Type, <span class="kw-2">&</span>[u8])> { |
| <span class="kw">let </span>pos = bytes.iter().cloned().position(|b| b == JSON_END_OF_PATH)<span class="question-mark">?</span>; |
| <span class="kw">let </span>json_path = str::from_utf8(<span class="kw-2">&</span>bytes[..pos]).ok()<span class="question-mark">?</span>; |
| <span class="kw">let </span>type_code = <span class="kw-2">*</span>bytes.get(pos + <span class="number">1</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span>typ = Type::from_code(type_code)<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>((json_path, typ, <span class="kw-2">&</span>bytes[pos + <span class="number">2</span>..])) |
| } |
| |
| <span class="kw">fn </span>debug_value_bytes(typ: Type, bytes: <span class="kw-2">&</span>[u8], f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">match </span>typ { |
| Type::Str => { |
| <span class="kw">let </span>s = as_str(bytes); |
| write_opt(f, s)<span class="question-mark">?</span>; |
| } |
| Type::U64 => { |
| write_opt(f, get_fast_type::<u64>(bytes))<span class="question-mark">?</span>; |
| } |
| Type::I64 => { |
| write_opt(f, get_fast_type::<i64>(bytes))<span class="question-mark">?</span>; |
| } |
| Type::F64 => { |
| write_opt(f, get_fast_type::<f64>(bytes))<span class="question-mark">?</span>; |
| } |
| Type::Bool => { |
| write_opt(f, get_fast_type::<bool>(bytes))<span class="question-mark">?</span>; |
| } |
| <span class="comment">// TODO pretty print these types too. |
| </span>Type::Date => { |
| write_opt(f, get_fast_type::<DateTime>(bytes))<span class="question-mark">?</span>; |
| } |
| Type::Facet => { |
| <span class="kw">let </span>facet_str = str::from_utf8(bytes) |
| .ok() |
| .map(ToString::to_string) |
| .map(Facet::from_encoded_string) |
| .map(|facet| facet.to_path_string()); |
| write_opt(f, facet_str)<span class="question-mark">?</span>; |
| } |
| Type::Bytes => { |
| write_opt(f, <span class="prelude-val">Some</span>(bytes))<span class="question-mark">?</span>; |
| } |
| Type::Json => { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>((path, typ, bytes)) = as_json_path_type_value_bytes(bytes) { |
| <span class="kw">let </span>path_pretty = path.replace(JSON_PATH_SEGMENT_SEP_STR, <span class="string">"."</span>); |
| <span class="macro">write!</span>(f, <span class="string">"path={path_pretty}, vtype={typ:?}, "</span>)<span class="question-mark">?</span>; |
| debug_value_bytes(typ, bytes, f)<span class="question-mark">?</span>; |
| } |
| } |
| Type::IpAddr => { |
| <span class="macro">write!</span>(f, <span class="string">""</span>)<span class="question-mark">?</span>; <span class="comment">// TODO change once we actually have IP address terms. |
| </span>} |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="kw">impl</span><B> fmt::Debug <span class="kw">for </span>Term<B> |
| <span class="kw">where </span>B: AsRef<[u8]> |
| { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">let </span>field_id = <span class="self">self</span>.field().field_id(); |
| <span class="kw">let </span>typ = <span class="self">self</span>.typ(); |
| <span class="macro">write!</span>(f, <span class="string">"Term(type={typ:?}, field={field_id}, "</span>)<span class="question-mark">?</span>; |
| debug_value_bytes(typ, <span class="self">self</span>.value_bytes(), f)<span class="question-mark">?</span>; |
| <span class="macro">write!</span>(f, <span class="string">")"</span>,)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| |
| <span class="kw">use </span><span class="kw">crate</span>::schema::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>test_term_str() { |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| schema_builder.add_text_field(<span class="string">"text"</span>, STRING); |
| <span class="kw">let </span>title_field = schema_builder.add_text_field(<span class="string">"title"</span>, STRING); |
| <span class="kw">let </span>term = Term::from_field_text(title_field, <span class="string">"test"</span>); |
| <span class="macro">assert_eq!</span>(term.field(), title_field); |
| <span class="macro">assert_eq!</span>(term.typ(), Type::Str); |
| <span class="macro">assert_eq!</span>(term.as_str(), <span class="prelude-val">Some</span>(<span class="string">"test"</span>)) |
| } |
| |
| <span class="doccomment">/// Size (in bytes) of the buffer of a fast value (u64, i64, f64, or date) term. |
| /// <field> + <type byte> + <value len> |
| /// |
| /// - <field> is a big endian encoded u32 field id |
| /// - <type_byte>'s most significant bit expresses whether the term is a json term or not |
| /// The remaining 7 bits are used to encode the type of the value. |
| /// If this is a JSON term, the type is the type of the leaf of the json. |
| /// |
| /// - <value> is, if this is not the json term, a binary representation specific to the type. |
| /// If it is a JSON Term, then it is prepended with the path that leads to this leaf value. |
| </span><span class="kw">const </span>FAST_VALUE_TERM_LEN: usize = <span class="number">4 </span>+ <span class="number">1 </span>+ <span class="number">8</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>test_term_u64() { |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| <span class="kw">let </span>count_field = schema_builder.add_u64_field(<span class="string">"count"</span>, INDEXED); |
| <span class="kw">let </span>term = Term::from_field_u64(count_field, <span class="number">983u64</span>); |
| <span class="macro">assert_eq!</span>(term.field(), count_field); |
| <span class="macro">assert_eq!</span>(term.typ(), Type::U64); |
| <span class="macro">assert_eq!</span>(term.as_slice().len(), FAST_VALUE_TERM_LEN); |
| <span class="macro">assert_eq!</span>(term.as_u64(), <span class="prelude-val">Some</span>(<span class="number">983u64</span>)) |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>test_term_bool() { |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| <span class="kw">let </span>bool_field = schema_builder.add_bool_field(<span class="string">"bool"</span>, INDEXED); |
| <span class="kw">let </span>term = Term::from_field_bool(bool_field, <span class="bool-val">true</span>); |
| <span class="macro">assert_eq!</span>(term.field(), bool_field); |
| <span class="macro">assert_eq!</span>(term.typ(), Type::Bool); |
| <span class="macro">assert_eq!</span>(term.as_slice().len(), FAST_VALUE_TERM_LEN); |
| <span class="macro">assert_eq!</span>(term.as_bool(), <span class="prelude-val">Some</span>(<span class="bool-val">true</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> |
