blob: 292c54c00a786053429d327dd1d864fb2080a51c [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/collector/top_score_collector.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>top_score_collector.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>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
<span id="765">765</span>
<span id="766">766</span>
<span id="767">767</span>
<span id="768">768</span>
<span id="769">769</span>
<span id="770">770</span>
<span id="771">771</span>
<span id="772">772</span>
<span id="773">773</span>
<span id="774">774</span>
<span id="775">775</span>
<span id="776">776</span>
<span id="777">777</span>
<span id="778">778</span>
<span id="779">779</span>
<span id="780">780</span>
<span id="781">781</span>
<span id="782">782</span>
<span id="783">783</span>
<span id="784">784</span>
<span id="785">785</span>
<span id="786">786</span>
<span id="787">787</span>
<span id="788">788</span>
<span id="789">789</span>
<span id="790">790</span>
<span id="791">791</span>
<span id="792">792</span>
<span id="793">793</span>
<span id="794">794</span>
<span id="795">795</span>
<span id="796">796</span>
<span id="797">797</span>
<span id="798">798</span>
<span id="799">799</span>
<span id="800">800</span>
<span id="801">801</span>
<span id="802">802</span>
<span id="803">803</span>
<span id="804">804</span>
<span id="805">805</span>
<span id="806">806</span>
<span id="807">807</span>
<span id="808">808</span>
<span id="809">809</span>
<span id="810">810</span>
<span id="811">811</span>
<span id="812">812</span>
<span id="813">813</span>
<span id="814">814</span>
<span id="815">815</span>
<span id="816">816</span>
<span id="817">817</span>
<span id="818">818</span>
<span id="819">819</span>
<span id="820">820</span>
<span id="821">821</span>
<span id="822">822</span>
<span id="823">823</span>
<span id="824">824</span>
<span id="825">825</span>
<span id="826">826</span>
<span id="827">827</span>
<span id="828">828</span>
<span id="829">829</span>
<span id="830">830</span>
<span id="831">831</span>
<span id="832">832</span>
<span id="833">833</span>
<span id="834">834</span>
<span id="835">835</span>
<span id="836">836</span>
<span id="837">837</span>
<span id="838">838</span>
<span id="839">839</span>
<span id="840">840</span>
<span id="841">841</span>
<span id="842">842</span>
<span id="843">843</span>
<span id="844">844</span>
<span id="845">845</span>
<span id="846">846</span>
<span id="847">847</span>
<span id="848">848</span>
<span id="849">849</span>
<span id="850">850</span>
<span id="851">851</span>
<span id="852">852</span>
<span id="853">853</span>
<span id="854">854</span>
<span id="855">855</span>
<span id="856">856</span>
<span id="857">857</span>
<span id="858">858</span>
<span id="859">859</span>
<span id="860">860</span>
<span id="861">861</span>
<span id="862">862</span>
<span id="863">863</span>
<span id="864">864</span>
<span id="865">865</span>
<span id="866">866</span>
<span id="867">867</span>
<span id="868">868</span>
<span id="869">869</span>
<span id="870">870</span>
<span id="871">871</span>
<span id="872">872</span>
<span id="873">873</span>
<span id="874">874</span>
<span id="875">875</span>
<span id="876">876</span>
<span id="877">877</span>
<span id="878">878</span>
<span id="879">879</span>
<span id="880">880</span>
<span id="881">881</span>
<span id="882">882</span>
<span id="883">883</span>
<span id="884">884</span>
<span id="885">885</span>
<span id="886">886</span>
<span id="887">887</span>
<span id="888">888</span>
<span id="889">889</span>
<span id="890">890</span>
<span id="891">891</span>
<span id="892">892</span>
<span id="893">893</span>
<span id="894">894</span>
<span id="895">895</span>
<span id="896">896</span>
<span id="897">897</span>
<span id="898">898</span>
<span id="899">899</span>
<span id="900">900</span>
<span id="901">901</span>
<span id="902">902</span>
<span id="903">903</span>
<span id="904">904</span>
<span id="905">905</span>
<span id="906">906</span>
<span id="907">907</span>
<span id="908">908</span>
<span id="909">909</span>
<span id="910">910</span>
<span id="911">911</span>
<span id="912">912</span>
<span id="913">913</span>
<span id="914">914</span>
<span id="915">915</span>
<span id="916">916</span>
<span id="917">917</span>
<span id="918">918</span>
<span id="919">919</span>
<span id="920">920</span>
<span id="921">921</span>
<span id="922">922</span>
<span id="923">923</span>
<span id="924">924</span>
<span id="925">925</span>
<span id="926">926</span>
<span id="927">927</span>
<span id="928">928</span>
<span id="929">929</span>
<span id="930">930</span>
<span id="931">931</span>
<span id="932">932</span>
<span id="933">933</span>
<span id="934">934</span>
<span id="935">935</span>
<span id="936">936</span>
<span id="937">937</span>
<span id="938">938</span>
<span id="939">939</span>
<span id="940">940</span>
<span id="941">941</span>
<span id="942">942</span>
<span id="943">943</span>
<span id="944">944</span>
<span id="945">945</span>
<span id="946">946</span>
<span id="947">947</span>
<span id="948">948</span>
<span id="949">949</span>
<span id="950">950</span>
<span id="951">951</span>
<span id="952">952</span>
<span id="953">953</span>
<span id="954">954</span>
<span id="955">955</span>
<span id="956">956</span>
<span id="957">957</span>
<span id="958">958</span>
<span id="959">959</span>
<span id="960">960</span>
<span id="961">961</span>
<span id="962">962</span>
<span id="963">963</span>
<span id="964">964</span>
<span id="965">965</span>
<span id="966">966</span>
<span id="967">967</span>
<span id="968">968</span>
<span id="969">969</span>
<span id="970">970</span>
<span id="971">971</span>
<span id="972">972</span>
<span id="973">973</span>
<span id="974">974</span>
<span id="975">975</span>
<span id="976">976</span>
<span id="977">977</span>
<span id="978">978</span>
<span id="979">979</span>
<span id="980">980</span>
<span id="981">981</span>
<span id="982">982</span>
<span id="983">983</span>
<span id="984">984</span>
<span id="985">985</span>
<span id="986">986</span>
<span id="987">987</span>
<span id="988">988</span>
<span id="989">989</span>
<span id="990">990</span>
<span id="991">991</span>
<span id="992">992</span>
<span id="993">993</span>
<span id="994">994</span>
<span id="995">995</span>
<span id="996">996</span>
<span id="997">997</span>
<span id="998">998</span>
<span id="999">999</span>
<span id="1000">1000</span>
<span id="1001">1001</span>
<span id="1002">1002</span>
<span id="1003">1003</span>
<span id="1004">1004</span>
<span id="1005">1005</span>
<span id="1006">1006</span>
<span id="1007">1007</span>
<span id="1008">1008</span>
<span id="1009">1009</span>
<span id="1010">1010</span>
<span id="1011">1011</span>
<span id="1012">1012</span>
<span id="1013">1013</span>
<span id="1014">1014</span>
<span id="1015">1015</span>
<span id="1016">1016</span>
<span id="1017">1017</span>
<span id="1018">1018</span>
<span id="1019">1019</span>
<span id="1020">1020</span>
<span id="1021">1021</span>
<span id="1022">1022</span>
<span id="1023">1023</span>
<span id="1024">1024</span>
<span id="1025">1025</span>
<span id="1026">1026</span>
<span id="1027">1027</span>
<span id="1028">1028</span>
<span id="1029">1029</span>
<span id="1030">1030</span>
<span id="1031">1031</span>
<span id="1032">1032</span>
<span id="1033">1033</span>
<span id="1034">1034</span>
<span id="1035">1035</span>
<span id="1036">1036</span>
<span id="1037">1037</span>
<span id="1038">1038</span>
<span id="1039">1039</span>
<span id="1040">1040</span>
<span id="1041">1041</span>
<span id="1042">1042</span>
<span id="1043">1043</span>
<span id="1044">1044</span>
<span id="1045">1045</span>
<span id="1046">1046</span>
<span id="1047">1047</span>
<span id="1048">1048</span>
<span id="1049">1049</span>
<span id="1050">1050</span>
<span id="1051">1051</span>
<span id="1052">1052</span>
<span id="1053">1053</span>
<span id="1054">1054</span>
<span id="1055">1055</span>
<span id="1056">1056</span>
<span id="1057">1057</span>
<span id="1058">1058</span>
<span id="1059">1059</span>
<span id="1060">1060</span>
<span id="1061">1061</span>
<span id="1062">1062</span>
<span id="1063">1063</span>
<span id="1064">1064</span>
<span id="1065">1065</span>
<span id="1066">1066</span>
<span id="1067">1067</span>
<span id="1068">1068</span>
<span id="1069">1069</span>
<span id="1070">1070</span>
<span id="1071">1071</span>
<span id="1072">1072</span>
<span id="1073">1073</span>
<span id="1074">1074</span>
<span id="1075">1075</span>
<span id="1076">1076</span>
<span id="1077">1077</span>
<span id="1078">1078</span>
<span id="1079">1079</span>
<span id="1080">1080</span>
<span id="1081">1081</span>
<span id="1082">1082</span>
<span id="1083">1083</span>
<span id="1084">1084</span>
<span id="1085">1085</span>
<span id="1086">1086</span>
<span id="1087">1087</span>
<span id="1088">1088</span>
<span id="1089">1089</span>
<span id="1090">1090</span>
<span id="1091">1091</span>
<span id="1092">1092</span>
<span id="1093">1093</span>
<span id="1094">1094</span>
<span id="1095">1095</span>
<span id="1096">1096</span>
<span id="1097">1097</span>
<span id="1098">1098</span>
<span id="1099">1099</span>
<span id="1100">1100</span>
<span id="1101">1101</span>
<span id="1102">1102</span>
<span id="1103">1103</span>
<span id="1104">1104</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::collections::BinaryHeap;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::marker::PhantomData;
<span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>fastfield_codecs::Column;
<span class="kw">use </span><span class="kw">super</span>::Collector;
<span class="kw">use </span><span class="kw">crate</span>::collector::custom_score_top_collector::CustomScoreTopCollector;
<span class="kw">use </span><span class="kw">crate</span>::collector::top_collector::{ComparableDoc, TopCollector, TopSegmentCollector};
<span class="kw">use </span><span class="kw">crate</span>::collector::tweak_score_top_collector::TweakedScoreTopCollector;
<span class="kw">use </span><span class="kw">crate</span>::collector::{
CustomScorer, CustomSegmentScorer, ScoreSegmentTweaker, ScoreTweaker, SegmentCollector,
};
<span class="kw">use </span><span class="kw">crate</span>::fastfield::FastValue;
<span class="kw">use </span><span class="kw">crate</span>::query::Weight;
<span class="kw">use </span><span class="kw">crate</span>::schema::Field;
<span class="kw">use crate</span>::{DocAddress, DocId, Score, SegmentOrdinal, SegmentReader, TantivyError};
<span class="kw">struct </span>FastFieldConvertCollector&lt;
TCollector: Collector&lt;Fruit = Vec&lt;(u64, DocAddress)&gt;&gt;,
TFastValue: FastValue,
&gt; {
<span class="kw">pub </span>collector: TCollector,
<span class="kw">pub </span>field: Field,
<span class="kw">pub </span>fast_value: std::marker::PhantomData&lt;TFastValue&gt;,
}
<span class="kw">impl</span>&lt;TCollector, TFastValue&gt; Collector <span class="kw">for </span>FastFieldConvertCollector&lt;TCollector, TFastValue&gt;
<span class="kw">where
</span>TCollector: Collector&lt;Fruit = Vec&lt;(u64, DocAddress)&gt;&gt;,
TFastValue: FastValue,
{
<span class="kw">type </span>Fruit = Vec&lt;(TFastValue, DocAddress)&gt;;
<span class="kw">type </span>Child = TCollector::Child;
<span class="kw">fn </span>for_segment(
<span class="kw-2">&amp;</span><span class="self">self</span>,
segment_local_id: <span class="kw">crate</span>::SegmentOrdinal,
segment: <span class="kw-2">&amp;</span>SegmentReader,
) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>::Child&gt; {
<span class="kw">let </span>schema = segment.schema();
<span class="kw">let </span>field_entry = schema.get_field_entry(<span class="self">self</span>.field);
<span class="kw">if </span>!field_entry.is_fast() {
<span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::SchemaError(<span class="macro">format!</span>(
<span class="string">&quot;Field {:?} is not a fast field.&quot;</span>,
field_entry.name()
)));
}
<span class="kw">let </span>schema_type = TFastValue::to_type();
<span class="kw">let </span>requested_type = field_entry.field_type().value_type();
<span class="kw">if </span>schema_type != requested_type {
<span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::SchemaError(<span class="macro">format!</span>(
<span class="string">&quot;Field {:?} is of type {:?}!={:?}&quot;</span>,
field_entry.name(),
schema_type,
requested_type
)));
}
<span class="self">self</span>.collector.for_segment(segment_local_id, segment)
}
<span class="kw">fn </span>requires_scoring(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.collector.requires_scoring()
}
<span class="kw">fn </span>merge_fruits(
<span class="kw-2">&amp;</span><span class="self">self</span>,
segment_fruits: Vec&lt;&lt;<span class="self">Self</span>::Child <span class="kw">as </span>SegmentCollector&gt;::Fruit&gt;,
) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>::Fruit&gt; {
<span class="kw">let </span>raw_result = <span class="self">self</span>.collector.merge_fruits(segment_fruits)<span class="question-mark">?</span>;
<span class="kw">let </span>transformed_result = raw_result
.into_iter()
.map(|(score, doc_address)| (TFastValue::from_u64(score), doc_address))
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;();
<span class="prelude-val">Ok</span>(transformed_result)
}
}
<span class="doccomment">/// The `TopDocs` collector keeps track of the top `K` documents
/// sorted by their score.
///
/// The implementation is based on a `BinaryHeap`.
/// The theoretical complexity for collecting the top `K` out of `n` documents
/// is `O(n log K)`.
///
/// This collector guarantees a stable sorting in case of a tie on the
/// document score. As such, it is suitable to implement pagination.
///
/// ```rust
/// use tantivy::collector::TopDocs;
/// use tantivy::query::QueryParser;
/// use tantivy::schema::{Schema, TEXT};
/// use tantivy::{doc, DocAddress, Index};
///
/// # fn main() -&gt; tantivy::Result&lt;()&gt; {
/// let mut schema_builder = Schema::builder();
/// let title = schema_builder.add_text_field(&quot;title&quot;, TEXT);
/// let schema = schema_builder.build();
/// let index = Index::create_in_ram(schema);
///
/// let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
/// index_writer.add_document(doc!(title =&gt; &quot;The Name of the Wind&quot;))?;
/// index_writer.add_document(doc!(title =&gt; &quot;The Diary of Muadib&quot;))?;
/// index_writer.add_document(doc!(title =&gt; &quot;A Dairy Cow&quot;))?;
/// index_writer.add_document(doc!(title =&gt; &quot;The Diary of a Young Girl&quot;))?;
/// index_writer.commit()?;
///
/// let reader = index.reader()?;
/// let searcher = reader.searcher();
///
/// let query_parser = QueryParser::for_index(&amp;index, vec![title]);
/// let query = query_parser.parse_query(&quot;diary&quot;)?;
/// let top_docs = searcher.search(&amp;query, &amp;TopDocs::with_limit(2))?;
///
/// assert_eq!(top_docs[0].1, DocAddress::new(0, 1));
/// assert_eq!(top_docs[1].1, DocAddress::new(0, 3));
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub struct </span>TopDocs(TopCollector&lt;Score&gt;);
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TopDocs {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="macro">write!</span>(
f,
<span class="string">&quot;TopDocs(limit={}, offset={})&quot;</span>,
<span class="self">self</span>.<span class="number">0</span>.limit, <span class="self">self</span>.<span class="number">0</span>.offset
)
}
}
<span class="kw">struct </span>ScorerByFastFieldReader {
ff_reader: Arc&lt;<span class="kw">dyn </span>Column&lt;u64&gt;&gt;,
}
<span class="kw">impl </span>CustomSegmentScorer&lt;u64&gt; <span class="kw">for </span>ScorerByFastFieldReader {
<span class="kw">fn </span>score(<span class="kw-2">&amp;mut </span><span class="self">self</span>, doc: DocId) -&gt; u64 {
<span class="self">self</span>.ff_reader.get_val(doc)
}
}
<span class="kw">struct </span>ScorerByField {
field: Field,
}
<span class="kw">impl </span>CustomScorer&lt;u64&gt; <span class="kw">for </span>ScorerByField {
<span class="kw">type </span>Child = ScorerByFastFieldReader;
<span class="kw">fn </span>segment_scorer(<span class="kw-2">&amp;</span><span class="self">self</span>, segment_reader: <span class="kw-2">&amp;</span>SegmentReader) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>::Child&gt; {
<span class="comment">// We interpret this field as u64, regardless of its type, that way,
// we avoid needless conversion. Regardless of the fast field type, the
// mapping is monotonic, so it is sufficient to compute our top-K docs.
//
// The conversion will then happen only on the top-K docs.
</span><span class="kw">let </span>ff_reader = segment_reader
.fast_fields()
.typed_fast_field_reader(<span class="self">self</span>.field)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(ScorerByFastFieldReader { ff_reader })
}
}
<span class="kw">impl </span>TopDocs {
<span class="doccomment">/// Creates a top score collector, with a number of documents equal to &quot;limit&quot;.
///
/// # Panics
/// The method panics if limit is 0
</span><span class="kw">pub fn </span>with_limit(limit: usize) -&gt; TopDocs {
TopDocs(TopCollector::with_limit(limit))
}
<span class="doccomment">/// Skip the first &quot;offset&quot; documents when collecting.
///
/// This is equivalent to `OFFSET` in MySQL or PostgreSQL and `start` in
/// Lucene&#39;s TopDocsCollector.
///
/// # Example
///
/// ```rust
/// use tantivy::collector::TopDocs;
/// use tantivy::query::QueryParser;
/// use tantivy::schema::{Schema, TEXT};
/// use tantivy::{doc, DocAddress, Index};
///
/// # fn main() -&gt; tantivy::Result&lt;()&gt; {
/// let mut schema_builder = Schema::builder();
/// let title = schema_builder.add_text_field(&quot;title&quot;, TEXT);
/// let schema = schema_builder.build();
/// let index = Index::create_in_ram(schema);
///
/// let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
/// index_writer.add_document(doc!(title =&gt; &quot;The Name of the Wind&quot;))?;
/// index_writer.add_document(doc!(title =&gt; &quot;The Diary of Muadib&quot;))?;
/// index_writer.add_document(doc!(title =&gt; &quot;A Dairy Cow&quot;))?;
/// index_writer.add_document(doc!(title =&gt; &quot;The Diary of a Young Girl&quot;))?;
/// index_writer.add_document(doc!(title =&gt; &quot;The Diary of Lena Mukhina&quot;))?;
/// index_writer.commit()?;
///
/// let reader = index.reader()?;
/// let searcher = reader.searcher();
///
/// let query_parser = QueryParser::for_index(&amp;index, vec![title]);
/// let query = query_parser.parse_query(&quot;diary&quot;)?;
/// let top_docs = searcher.search(&amp;query, &amp;TopDocs::with_limit(2).and_offset(1))?;
///
/// assert_eq!(top_docs.len(), 2);
/// assert_eq!(top_docs[0].1, DocAddress::new(0, 4));
/// assert_eq!(top_docs[1].1, DocAddress::new(0, 3));
/// Ok(())
/// # }
/// ```
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>and_offset(<span class="self">self</span>, offset: usize) -&gt; TopDocs {
TopDocs(<span class="self">self</span>.<span class="number">0</span>.and_offset(offset))
}
<span class="doccomment">/// Set top-K to rank documents by a given fast field.
///
/// If the field is not a fast or does not exist, this method returns successfully (it is not
/// aware of any schema). An error will be returned at the moment of search.
///
/// If the field is a FAST field but not a u64 field, search will return successfully but it
/// will return returns a monotonic u64-representation (ie. the order is still correct) of
/// the requested field type.
///
/// # Example
///
/// ```rust
/// # use tantivy::schema::{Schema, FAST, TEXT};
/// # use tantivy::{doc, Index, DocAddress};
/// # use tantivy::query::{Query, QueryParser};
/// use tantivy::Searcher;
/// use tantivy::collector::TopDocs;
/// use tantivy::schema::Field;
///
/// # fn main() -&gt; tantivy::Result&lt;()&gt; {
/// # let mut schema_builder = Schema::builder();
/// # let title = schema_builder.add_text_field(&quot;title&quot;, TEXT);
/// # let rating = schema_builder.add_u64_field(&quot;rating&quot;, FAST);
/// # let schema = schema_builder.build();
/// #
/// # let index = Index::create_in_ram(schema);
/// # let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
/// # index_writer.add_document(doc!(title =&gt; &quot;The Name of the Wind&quot;, rating =&gt; 92u64))?;
/// # index_writer.add_document(doc!(title =&gt; &quot;The Diary of Muadib&quot;, rating =&gt; 97u64))?;
/// # index_writer.add_document(doc!(title =&gt; &quot;A Dairy Cow&quot;, rating =&gt; 63u64))?;
/// # index_writer.add_document(doc!(title =&gt; &quot;The Diary of a Young Girl&quot;, rating =&gt; 80u64))?;
/// # index_writer.commit()?;
/// # let reader = index.reader()?;
/// # let query = QueryParser::for_index(&amp;index, vec![title]).parse_query(&quot;diary&quot;)?;
/// # let top_docs = docs_sorted_by_rating(&amp;reader.searcher(), &amp;query, rating)?;
/// # assert_eq!(top_docs,
/// # vec![(97u64, DocAddress::new(0u32, 1)),
/// # (80u64, DocAddress::new(0u32, 3))]);
/// # Ok(())
/// # }
/// /// Searches the document matching the given query, and
/// /// collects the top 10 documents, order by the u64-`field`
/// /// given in argument.
/// fn docs_sorted_by_rating(searcher: &amp;Searcher,
/// query: &amp;dyn Query,
/// rating_field: Field)
/// -&gt; tantivy::Result&lt;Vec&lt;(u64, DocAddress)&gt;&gt; {
///
/// // This is where we build our topdocs collector
/// //
/// // Note the `rating_field` needs to be a FAST field here.
/// let top_books_by_rating = TopDocs
/// ::with_limit(10)
/// .order_by_u64_field(rating_field);
///
/// // ... and here are our documents. Note this is a simple vec.
/// // The `u64` in the pair is the value of our fast field for
/// // each documents.
/// //
/// // The vec is sorted decreasingly by `sort_by_field`, and has a
/// // length of 10, or less if not enough documents matched the
/// // query.
/// let resulting_docs: Vec&lt;(u64, DocAddress)&gt; =
/// searcher.search(query, &amp;top_books_by_rating)?;
///
/// Ok(resulting_docs)
/// }
/// ```
///
/// # See also
///
/// To comfortably work with `u64`s, `i64`s, `f64`s, or `date`s, please refer to
/// the [.order_by_fast_field(...)](TopDocs::order_by_fast_field) method.
</span><span class="kw">pub fn </span>order_by_u64_field(
<span class="self">self</span>,
field: Field,
) -&gt; <span class="kw">impl </span>Collector&lt;Fruit = Vec&lt;(u64, DocAddress)&gt;&gt; {
CustomScoreTopCollector::new(ScorerByField { field }, <span class="self">self</span>.<span class="number">0</span>.into_tscore())
}
<span class="doccomment">/// Set top-K to rank documents by a given fast field.
///
/// If the field is not a fast field, or its field type does not match the generic type, this
/// method does not panic, but an explicit error will be returned at the moment of
/// collection.
///
/// Note that this method is a generic. The requested fast field type will be often
/// inferred in your code by the rust compiler.
///
/// Implementation-wise, for performance reason, tantivy will manipulate the u64 representation
/// of your fast field until the last moment.
///
/// # Example
///
/// ```rust
/// # use tantivy::schema::{Schema, FAST, TEXT};
/// # use tantivy::{doc, Index, DocAddress};
/// # use tantivy::query::{Query, AllQuery};
/// use tantivy::Searcher;
/// use tantivy::collector::TopDocs;
/// use tantivy::schema::Field;
///
/// # fn main() -&gt; tantivy::Result&lt;()&gt; {
/// # let mut schema_builder = Schema::builder();
/// # let title = schema_builder.add_text_field(&quot;company&quot;, TEXT);
/// # let rating = schema_builder.add_i64_field(&quot;revenue&quot;, FAST);
/// # let schema = schema_builder.build();
/// #
/// # let index = Index::create_in_ram(schema);
/// # let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
/// # index_writer.add_document(doc!(title =&gt; &quot;MadCow Inc.&quot;, rating =&gt; 92_000_000i64))?;
/// # index_writer.add_document(doc!(title =&gt; &quot;Zozo Cow KKK&quot;, rating =&gt; 119_000_000i64))?;
/// # index_writer.add_document(doc!(title =&gt; &quot;Declining Cow&quot;, rating =&gt; -63_000_000i64))?;
/// # assert!(index_writer.commit().is_ok());
/// # let reader = index.reader()?;
/// # let top_docs = docs_sorted_by_revenue(&amp;reader.searcher(), &amp;AllQuery, rating)?;
/// # assert_eq!(top_docs,
/// # vec![(119_000_000i64, DocAddress::new(0, 1)),
/// # (92_000_000i64, DocAddress::new(0, 0))]);
/// # Ok(())
/// # }
/// /// Searches the document matching the given query, and
/// /// collects the top 10 documents, order by the u64-`field`
/// /// given in argument.
/// fn docs_sorted_by_revenue(searcher: &amp;Searcher,
/// query: &amp;dyn Query,
/// revenue_field: Field)
/// -&gt; tantivy::Result&lt;Vec&lt;(i64, DocAddress)&gt;&gt; {
///
/// // This is where we build our topdocs collector
/// //
/// // Note the generics parameter that needs to match the
/// // type `sort_by_field`. revenue_field here is a FAST i64 field.
/// let top_company_by_revenue = TopDocs
/// ::with_limit(2)
/// .order_by_fast_field(revenue_field);
///
/// // ... and here are our documents. Note this is a simple vec.
/// // The `i64` in the pair is the value of our fast field for
/// // each documents.
/// //
/// // The vec is sorted decreasingly by `sort_by_field`, and has a
/// // length of 10, or less if not enough documents matched the
/// // query.
/// let resulting_docs: Vec&lt;(i64, DocAddress)&gt; =
/// searcher.search(query, &amp;top_company_by_revenue)?;
///
/// Ok(resulting_docs)
/// }
/// ```
</span><span class="kw">pub fn </span>order_by_fast_field&lt;TFastValue&gt;(
<span class="self">self</span>,
fast_field: Field,
) -&gt; <span class="kw">impl </span>Collector&lt;Fruit = Vec&lt;(TFastValue, DocAddress)&gt;&gt;
<span class="kw">where
</span>TFastValue: FastValue,
{
<span class="kw">let </span>u64_collector = <span class="self">self</span>.order_by_u64_field(fast_field);
FastFieldConvertCollector {
collector: u64_collector,
field: fast_field,
fast_value: PhantomData,
}
}
<span class="doccomment">/// Ranks the documents using a custom score.
///
/// This method offers a convenient way to tweak or replace
/// the documents score. As suggested by the prototype you can
/// manually define your own [`ScoreTweaker`]
/// and pass it as an argument, but there is a much simpler way to
/// tweak your score: you can use a closure as in the following
/// example.
///
/// # Example
///
/// Typically, you will want to rely on one or more fast fields,
/// to alter the original relevance `Score`.
///
/// For instance, in the following, we assume that we are implementing
/// an e-commerce website that has a fast field called `popularity`
/// that rates whether a product is typically often bought by users.
///
/// In the following example will will tweak our ranking a bit by
/// boosting popular products a notch.
///
/// In more serious application, this tweaking could involve running a
/// learning-to-rank model over various features
///
/// ```rust
/// # use tantivy::schema::{Schema, FAST, TEXT};
/// # use tantivy::{doc, Index, DocAddress, DocId, Score};
/// # use tantivy::query::QueryParser;
/// use tantivy::SegmentReader;
/// use tantivy::collector::TopDocs;
/// use tantivy::schema::Field;
///
/// fn create_schema() -&gt; Schema {
/// let mut schema_builder = Schema::builder();
/// schema_builder.add_text_field(&quot;product_name&quot;, TEXT);
/// schema_builder.add_u64_field(&quot;popularity&quot;, FAST);
/// schema_builder.build()
/// }
///
/// fn create_index() -&gt; tantivy::Result&lt;Index&gt; {
/// let schema = create_schema();
/// let index = Index::create_in_ram(schema);
/// let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
/// let product_name = index.schema().get_field(&quot;product_name&quot;).unwrap();
/// let popularity: Field = index.schema().get_field(&quot;popularity&quot;).unwrap();
/// index_writer.add_document(doc!(product_name =&gt; &quot;The Diary of Muadib&quot;, popularity =&gt; 1u64))?;
/// index_writer.add_document(doc!(product_name =&gt; &quot;A Dairy Cow&quot;, popularity =&gt; 10u64))?;
/// index_writer.add_document(doc!(product_name =&gt; &quot;The Diary of a Young Girl&quot;, popularity =&gt; 15u64))?;
/// index_writer.commit()?;
/// Ok(index)
/// }
///
/// let index = create_index().unwrap();
/// let product_name = index.schema().get_field(&quot;product_name&quot;).unwrap();
/// let popularity: Field = index.schema().get_field(&quot;popularity&quot;).unwrap();
///
/// let user_query_str = &quot;diary&quot;;
/// let query_parser = QueryParser::for_index(&amp;index, vec![product_name]);
/// let query = query_parser.parse_query(user_query_str).unwrap();
///
/// // This is where we build our collector with our custom score.
/// let top_docs_by_custom_score = TopDocs
/// ::with_limit(10)
/// .tweak_score(move |segment_reader: &amp;SegmentReader| {
/// // The argument is a function that returns our scoring
/// // function.
/// //
/// // The point of this &quot;mother&quot; function is to gather all
/// // of the segment level information we need for scoring.
/// // Typically, fast_fields.
/// //
/// // In our case, we will get a reader for the popularity
/// // fast field.
/// let popularity_reader =
/// segment_reader.fast_fields().u64(popularity).unwrap();
///
/// // We can now define our actual scoring function
/// move |doc: DocId, original_score: Score| {
/// let popularity: u64 = popularity_reader.get_val(doc);
/// // Well.. For the sake of the example we use a simple logarithm
/// // function.
/// let popularity_boost_score = ((2u64 + popularity) as Score).log2();
/// popularity_boost_score * original_score
/// }
/// });
/// let reader = index.reader().unwrap();
/// let searcher = reader.searcher();
/// // ... and here are our documents. Note this is a simple vec.
/// // The `Score` in the pair is our tweaked score.
/// let resulting_docs: Vec&lt;(Score, DocAddress)&gt; =
/// searcher.search(&amp;query, &amp;top_docs_by_custom_score).unwrap();
/// ```
///
/// # See also
/// - [custom_score(...)](TopDocs::custom_score)
</span><span class="kw">pub fn </span>tweak_score&lt;TScore, TScoreSegmentTweaker, TScoreTweaker&gt;(
<span class="self">self</span>,
score_tweaker: TScoreTweaker,
) -&gt; <span class="kw">impl </span>Collector&lt;Fruit = Vec&lt;(TScore, DocAddress)&gt;&gt;
<span class="kw">where
</span>TScore: <span class="lifetime">&#39;static </span>+ Send + Sync + Clone + PartialOrd,
TScoreSegmentTweaker: ScoreSegmentTweaker&lt;TScore&gt; + <span class="lifetime">&#39;static</span>,
TScoreTweaker: ScoreTweaker&lt;TScore, Child = TScoreSegmentTweaker&gt; + Send + Sync,
{
TweakedScoreTopCollector::new(score_tweaker, <span class="self">self</span>.<span class="number">0</span>.into_tscore())
}
<span class="doccomment">/// Ranks the documents using a custom score.
///
/// This method offers a convenient way to use a different score.
///
/// As suggested by the prototype you can manually define your own [`CustomScorer`]
/// and pass it as an argument, but there is a much simpler way to
/// tweak your score: you can use a closure as in the following
/// example.
///
/// # Limitation
///
/// This method only makes it possible to compute the score from a given
/// `DocId`, fastfield values for the doc and any information you could
/// have precomputed beforehand. It does not make it possible for instance
/// to compute something like TfIdf as it does not have access to the list of query
/// terms present in the document, nor the term frequencies for the different terms.
///
/// It can be used if your search engine relies on a learning-to-rank model for instance,
/// which does not rely on the term frequencies or positions as features.
///
/// # Example
///
/// ```rust
/// # use tantivy::schema::{Schema, FAST, TEXT};
/// # use tantivy::{doc, Index, DocAddress, DocId};
/// # use tantivy::query::QueryParser;
/// use tantivy::SegmentReader;
/// use tantivy::collector::TopDocs;
/// use tantivy::schema::Field;
///
/// # fn create_schema() -&gt; Schema {
/// # let mut schema_builder = Schema::builder();
/// # schema_builder.add_text_field(&quot;product_name&quot;, TEXT);
/// # schema_builder.add_u64_field(&quot;popularity&quot;, FAST);
/// # schema_builder.add_u64_field(&quot;boosted&quot;, FAST);
/// # schema_builder.build()
/// # }
/// #
/// # fn main() -&gt; tantivy::Result&lt;()&gt; {
/// # let schema = create_schema();
/// # let index = Index::create_in_ram(schema);
/// # let mut index_writer = index.writer_with_num_threads(1, 10_000_000)?;
/// # let product_name = index.schema().get_field(&quot;product_name&quot;).unwrap();
/// #
/// let popularity: Field = index.schema().get_field(&quot;popularity&quot;).unwrap();
/// let boosted: Field = index.schema().get_field(&quot;boosted&quot;).unwrap();
/// # index_writer.add_document(doc!(boosted=&gt;1u64, product_name =&gt; &quot;The Diary of Muadib&quot;, popularity =&gt; 1u64))?;
/// # index_writer.add_document(doc!(boosted=&gt;0u64, product_name =&gt; &quot;A Dairy Cow&quot;, popularity =&gt; 10u64))?;
/// # index_writer.add_document(doc!(boosted=&gt;0u64, product_name =&gt; &quot;The Diary of a Young Girl&quot;, popularity =&gt; 15u64))?;
/// # index_writer.commit()?;
/// // ...
/// # let user_query = &quot;diary&quot;;
/// # let query = QueryParser::for_index(&amp;index, vec![product_name]).parse_query(user_query)?;
///
/// // This is where we build our collector with our custom score.
/// let top_docs_by_custom_score = TopDocs
/// ::with_limit(10)
/// .custom_score(move |segment_reader: &amp;SegmentReader| {
/// // The argument is a function that returns our scoring
/// // function.
/// //
/// // The point of this &quot;mother&quot; function is to gather all
/// // of the segment level information we need for scoring.
/// // Typically, fast_fields.
/// //
/// // In our case, we will get a reader for the popularity
/// // fast field and a boosted field.
/// //
/// // We want to get boosted items score, and when we get
/// // a tie, return the item with the highest popularity.
/// //
/// // Note that this is implemented by using a `(u64, u64)`
/// // as a score.
/// let popularity_reader =
/// segment_reader.fast_fields().u64(popularity).unwrap();
/// let boosted_reader =
/// segment_reader.fast_fields().u64(boosted).unwrap();
///
/// // We can now define our actual scoring function
/// move |doc: DocId| {
/// let popularity: u64 = popularity_reader.get_val(doc);
/// let boosted: u64 = boosted_reader.get_val(doc);
/// // Score do not have to be `f64` in tantivy.
/// // Here we return a couple to get lexicographical order
/// // for free.
/// (boosted, popularity)
/// }
/// });
/// # let reader = index.reader()?;
/// # let searcher = reader.searcher();
/// // ... and here are our documents. Note this is a simple vec.
/// // The `Score` in the pair is our tweaked score.
/// let resulting_docs: Vec&lt;((u64, u64), DocAddress)&gt; =
/// searcher.search(&amp;*query, &amp;top_docs_by_custom_score)?;
///
/// # Ok(())
/// # }
/// ```
///
/// # See also
/// - [tweak_score(...)](TopDocs::tweak_score)
</span><span class="kw">pub fn </span>custom_score&lt;TScore, TCustomSegmentScorer, TCustomScorer&gt;(
<span class="self">self</span>,
custom_score: TCustomScorer,
) -&gt; <span class="kw">impl </span>Collector&lt;Fruit = Vec&lt;(TScore, DocAddress)&gt;&gt;
<span class="kw">where
</span>TScore: <span class="lifetime">&#39;static </span>+ Send + Sync + Clone + PartialOrd,
TCustomSegmentScorer: CustomSegmentScorer&lt;TScore&gt; + <span class="lifetime">&#39;static</span>,
TCustomScorer: CustomScorer&lt;TScore, Child = TCustomSegmentScorer&gt; + Send + Sync,
{
CustomScoreTopCollector::new(custom_score, <span class="self">self</span>.<span class="number">0</span>.into_tscore())
}
}
<span class="kw">impl </span>Collector <span class="kw">for </span>TopDocs {
<span class="kw">type </span>Fruit = Vec&lt;(Score, DocAddress)&gt;;
<span class="kw">type </span>Child = TopScoreSegmentCollector;
<span class="kw">fn </span>for_segment(
<span class="kw-2">&amp;</span><span class="self">self</span>,
segment_local_id: SegmentOrdinal,
reader: <span class="kw-2">&amp;</span>SegmentReader,
) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>::Child&gt; {
<span class="kw">let </span>collector = <span class="self">self</span>.<span class="number">0</span>.for_segment(segment_local_id, reader);
<span class="prelude-val">Ok</span>(TopScoreSegmentCollector(collector))
}
<span class="kw">fn </span>requires_scoring(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="bool-val">true
</span>}
<span class="kw">fn </span>merge_fruits(
<span class="kw-2">&amp;</span><span class="self">self</span>,
child_fruits: Vec&lt;Vec&lt;(Score, DocAddress)&gt;&gt;,
) -&gt; <span class="kw">crate</span>::Result&lt;<span class="self">Self</span>::Fruit&gt; {
<span class="self">self</span>.<span class="number">0</span>.merge_fruits(child_fruits)
}
<span class="kw">fn </span>collect_segment(
<span class="kw-2">&amp;</span><span class="self">self</span>,
weight: <span class="kw-2">&amp;</span><span class="kw">dyn </span>Weight,
segment_ord: u32,
reader: <span class="kw-2">&amp;</span>SegmentReader,
) -&gt; <span class="kw">crate</span>::Result&lt;&lt;<span class="self">Self</span>::Child <span class="kw">as </span>SegmentCollector&gt;::Fruit&gt; {
<span class="kw">let </span>heap_len = <span class="self">self</span>.<span class="number">0</span>.limit + <span class="self">self</span>.<span class="number">0</span>.offset;
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap&lt;ComparableDoc&lt;Score, DocId&gt;&gt; = BinaryHeap::with_capacity(heap_len);
<span class="kw">if let </span><span class="prelude-val">Some</span>(alive_bitset) = reader.alive_bitset() {
<span class="kw">let </span><span class="kw-2">mut </span>threshold = Score::MIN;
weight.for_each_pruning(threshold, reader, <span class="kw-2">&amp;mut </span>|doc, score| {
<span class="kw">if </span>alive_bitset.is_deleted(doc) {
<span class="kw">return </span>threshold;
}
<span class="kw">let </span>heap_item = ComparableDoc {
feature: score,
doc,
};
<span class="kw">if </span>heap.len() &lt; heap_len {
heap.push(heap_item);
<span class="kw">if </span>heap.len() == heap_len {
threshold = heap.peek().map(|el| el.feature).unwrap_or(Score::MIN);
}
<span class="kw">return </span>threshold;
}
<span class="kw-2">*</span>heap.peek_mut().unwrap() = heap_item;
threshold = heap.peek().map(|el| el.feature).unwrap_or(Score::MIN);
threshold
})<span class="question-mark">?</span>;
} <span class="kw">else </span>{
weight.for_each_pruning(Score::MIN, reader, <span class="kw-2">&amp;mut </span>|doc, score| {
<span class="kw">let </span>heap_item = ComparableDoc {
feature: score,
doc,
};
<span class="kw">if </span>heap.len() &lt; heap_len {
heap.push(heap_item);
<span class="comment">// TODO the threshold is suboptimal for heap.len == heap_len
</span><span class="kw">if </span>heap.len() == heap_len {
<span class="kw">return </span>heap.peek().map(|el| el.feature).unwrap_or(Score::MIN);
} <span class="kw">else </span>{
<span class="kw">return </span>Score::MIN;
}
}
<span class="kw-2">*</span>heap.peek_mut().unwrap() = heap_item;
heap.peek().map(|el| el.feature).unwrap_or(Score::MIN)
})<span class="question-mark">?</span>;
}
<span class="kw">let </span>fruit = heap
.into_sorted_vec()
.into_iter()
.map(|cid| {
(
cid.feature,
DocAddress {
segment_ord,
doc_id: cid.doc,
},
)
})
.collect();
<span class="prelude-val">Ok</span>(fruit)
}
}
<span class="doccomment">/// Segment Collector associated with `TopDocs`.
</span><span class="kw">pub struct </span>TopScoreSegmentCollector(TopSegmentCollector&lt;Score&gt;);
<span class="kw">impl </span>SegmentCollector <span class="kw">for </span>TopScoreSegmentCollector {
<span class="kw">type </span>Fruit = Vec&lt;(Score, DocAddress)&gt;;
<span class="kw">fn </span>collect(<span class="kw-2">&amp;mut </span><span class="self">self</span>, doc: DocId, score: Score) {
<span class="self">self</span>.<span class="number">0</span>.collect(doc, score);
}
<span class="kw">fn </span>harvest(<span class="self">self</span>) -&gt; Vec&lt;(Score, DocAddress)&gt; {
<span class="self">self</span>.<span class="number">0</span>.harvest()
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::TopDocs;
<span class="kw">use </span><span class="kw">crate</span>::collector::Collector;
<span class="kw">use </span><span class="kw">crate</span>::query::{AllQuery, Query, QueryParser};
<span class="kw">use </span><span class="kw">crate</span>::schema::{Field, Schema, FAST, STORED, TEXT};
<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, DocAddress, DocId, Index, IndexWriter, Score, SegmentReader};
<span class="kw">fn </span>make_index() -&gt; <span class="kw">crate</span>::Result&lt;Index&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>text_field = schema_builder.add_text_field(<span class="string">&quot;text&quot;</span>, TEXT);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="comment">// writing the segment
</span><span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_with_num_threads(<span class="number">1</span>, <span class="number">10_000_000</span>)<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(text_field=&gt;<span class="string">&quot;Hello happy tax payer.&quot;</span>))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(text_field=&gt;<span class="string">&quot;Droopy says hello happy tax payer&quot;</span>))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(text_field=&gt;<span class="string">&quot;I like Droopy&quot;</span>))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(index)
}
<span class="kw">fn </span>assert_results_equals(results: <span class="kw-2">&amp;</span>[(Score, DocAddress)], expected: <span class="kw-2">&amp;</span>[(Score, DocAddress)]) {
<span class="kw">for </span>(result, expected) <span class="kw">in </span>results.iter().zip(expected.iter()) {
<span class="macro">assert_eq!</span>(result.<span class="number">1</span>, expected.<span class="number">1</span>);
<span class="macro">crate::assert_nearly_equals!</span>(result.<span class="number">0</span>, expected.<span class="number">0</span>);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_collector_not_at_capacity_without_offset() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span>index = make_index()<span class="question-mark">?</span>;
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;text&quot;</span>).unwrap();
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[field]);
<span class="kw">let </span>text_query = query_parser.parse_query(<span class="string">&quot;droopy tax&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>score_docs: Vec&lt;(Score, DocAddress)&gt; = index
.reader()<span class="question-mark">?
</span>.searcher()
.search(<span class="kw-2">&amp;</span>text_query, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">4</span>))<span class="question-mark">?</span>;
assert_results_equals(
<span class="kw-2">&amp;</span>score_docs,
<span class="kw-2">&amp;</span>[
(<span class="number">0.81221175</span>, DocAddress::new(<span class="number">0u32</span>, <span class="number">1</span>)),
(<span class="number">0.5376842</span>, DocAddress::new(<span class="number">0u32</span>, <span class="number">2</span>)),
(<span class="number">0.48527452</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>)),
],
);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_collector_not_at_capacity_with_offset() {
<span class="kw">let </span>index = make_index().unwrap();
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;text&quot;</span>).unwrap();
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[field]);
<span class="kw">let </span>text_query = query_parser.parse_query(<span class="string">&quot;droopy tax&quot;</span>).unwrap();
<span class="kw">let </span>score_docs: Vec&lt;(Score, DocAddress)&gt; = index
.reader()
.unwrap()
.searcher()
.search(<span class="kw-2">&amp;</span>text_query, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">4</span>).and_offset(<span class="number">2</span>))
.unwrap();
assert_results_equals(<span class="kw-2">&amp;</span>score_docs[..], <span class="kw-2">&amp;</span>[(<span class="number">0.48527452</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>))]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_collector_at_capacity() {
<span class="kw">let </span>index = make_index().unwrap();
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;text&quot;</span>).unwrap();
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[field]);
<span class="kw">let </span>text_query = query_parser.parse_query(<span class="string">&quot;droopy tax&quot;</span>).unwrap();
<span class="kw">let </span>score_docs: Vec&lt;(Score, DocAddress)&gt; = index
.reader()
.unwrap()
.searcher()
.search(<span class="kw-2">&amp;</span>text_query, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">2</span>))
.unwrap();
assert_results_equals(
<span class="kw-2">&amp;</span>score_docs,
<span class="kw-2">&amp;</span>[
(<span class="number">0.81221175</span>, DocAddress::new(<span class="number">0u32</span>, <span class="number">1</span>)),
(<span class="number">0.5376842</span>, DocAddress::new(<span class="number">0u32</span>, <span class="number">2</span>)),
],
);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_collector_at_capacity_with_offset() {
<span class="kw">let </span>index = make_index().unwrap();
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;text&quot;</span>).unwrap();
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[field]);
<span class="kw">let </span>text_query = query_parser.parse_query(<span class="string">&quot;droopy tax&quot;</span>).unwrap();
<span class="kw">let </span>score_docs: Vec&lt;(Score, DocAddress)&gt; = index
.reader()
.unwrap()
.searcher()
.search(<span class="kw-2">&amp;</span>text_query, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">2</span>).and_offset(<span class="number">1</span>))
.unwrap();
assert_results_equals(
<span class="kw-2">&amp;</span>score_docs[..],
<span class="kw-2">&amp;</span>[
(<span class="number">0.5376842</span>, DocAddress::new(<span class="number">0u32</span>, <span class="number">2</span>)),
(<span class="number">0.48527452</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>)),
],
);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_collector_stable_sorting() {
<span class="kw">let </span>index = make_index().unwrap();
<span class="comment">// using AllQuery to get a constant score
</span><span class="kw">let </span>searcher = index.reader().unwrap().searcher();
<span class="kw">let </span>page_1 = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">2</span>)).unwrap();
<span class="kw">let </span>page_2 = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>TopDocs::with_limit(<span class="number">3</span>)).unwrap();
<span class="comment">// precondition for the test to be meaningful: we did get documents
// with the same score
</span><span class="macro">assert!</span>(page_1.iter().all(|result| result.<span class="number">0 </span>== page_1[<span class="number">0</span>].<span class="number">0</span>));
<span class="macro">assert!</span>(page_2.iter().all(|result| result.<span class="number">0 </span>== page_2[<span class="number">0</span>].<span class="number">0</span>));
<span class="comment">// sanity check since we&#39;re relying on make_index()
</span><span class="macro">assert_eq!</span>(page_1.len(), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(page_2.len(), <span class="number">3</span>);
<span class="macro">assert_eq!</span>(page_1, <span class="kw-2">&amp;</span>page_2[..page_1.len()]);
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">fn </span>test_top_0() {
TopDocs::with_limit(<span class="number">0</span>);
}
<span class="kw">const </span>TITLE: <span class="kw-2">&amp;</span>str = <span class="string">&quot;title&quot;</span>;
<span class="kw">const </span>SIZE: <span class="kw-2">&amp;</span>str = <span class="string">&quot;size&quot;</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_field_collector_not_at_capacity() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>title = schema_builder.add_text_field(TITLE, TEXT);
<span class="kw">let </span>size = schema_builder.add_u64_field(SIZE, FAST);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>(index, query) = index(<span class="string">&quot;beer&quot;</span>, title, schema, |index_writer| {
index_writer
.add_document(<span class="macro">doc!</span>(
title =&gt; <span class="string">&quot;bottle of beer&quot;</span>,
size =&gt; <span class="number">12u64</span>,
))
.unwrap();
index_writer
.add_document(<span class="macro">doc!</span>(
title =&gt; <span class="string">&quot;growler of beer&quot;</span>,
size =&gt; <span class="number">64u64</span>,
))
.unwrap();
index_writer
.add_document(<span class="macro">doc!</span>(
title =&gt; <span class="string">&quot;pint of beer&quot;</span>,
size =&gt; <span class="number">16u64</span>,
))
.unwrap();
});
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>top_collector = TopDocs::with_limit(<span class="number">4</span>).order_by_u64_field(size);
<span class="kw">let </span>top_docs: Vec&lt;(u64, DocAddress)&gt; = searcher.search(<span class="kw-2">&amp;</span>query, <span class="kw-2">&amp;</span>top_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(
<span class="kw-2">&amp;</span>top_docs[..],
<span class="kw-2">&amp;</span>[
(<span class="number">64</span>, DocAddress::new(<span class="number">0</span>, <span class="number">1</span>)),
(<span class="number">16</span>, DocAddress::new(<span class="number">0</span>, <span class="number">2</span>)),
(<span class="number">12</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>))
]
);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_field_collector_datetime() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>name = schema_builder.add_text_field(<span class="string">&quot;name&quot;</span>, TEXT);
<span class="kw">let </span>birthday = schema_builder.add_date_field(<span class="string">&quot;birthday&quot;</span>, FAST);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
<span class="kw">let </span>pr_birthday = DateTime::from_utc(OffsetDateTime::parse(
<span class="string">&quot;1898-04-09T00:00:00+00:00&quot;</span>,
<span class="kw-2">&amp;</span>Rfc3339,
)<span class="question-mark">?</span>);
index_writer.add_document(<span class="macro">doc!</span>(
name =&gt; <span class="string">&quot;Paul Robeson&quot;</span>,
birthday =&gt; pr_birthday,
))<span class="question-mark">?</span>;
<span class="kw">let </span>mr_birthday = DateTime::from_utc(OffsetDateTime::parse(
<span class="string">&quot;1947-11-08T00:00:00+00:00&quot;</span>,
<span class="kw-2">&amp;</span>Rfc3339,
)<span class="question-mark">?</span>);
index_writer.add_document(<span class="macro">doc!</span>(
name =&gt; <span class="string">&quot;Minnie Riperton&quot;</span>,
birthday =&gt; mr_birthday,
))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>top_collector = TopDocs::with_limit(<span class="number">3</span>).order_by_fast_field(birthday);
<span class="kw">let </span>top_docs: Vec&lt;(DateTime, DocAddress)&gt; = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>top_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(
<span class="kw-2">&amp;</span>top_docs[..],
<span class="kw-2">&amp;</span>[
(mr_birthday, DocAddress::new(<span class="number">0</span>, <span class="number">1</span>)),
(pr_birthday, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>)),
]
);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_field_collector_i64() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>city = schema_builder.add_text_field(<span class="string">&quot;city&quot;</span>, TEXT);
<span class="kw">let </span>altitude = schema_builder.add_i64_field(<span class="string">&quot;altitude&quot;</span>, FAST);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
city =&gt; <span class="string">&quot;georgetown&quot;</span>,
altitude =&gt; -<span class="number">1i64</span>,
))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
city =&gt; <span class="string">&quot;tokyo&quot;</span>,
altitude =&gt; <span class="number">40i64</span>,
))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>top_collector = TopDocs::with_limit(<span class="number">3</span>).order_by_fast_field(altitude);
<span class="kw">let </span>top_docs: Vec&lt;(i64, DocAddress)&gt; = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>top_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(
<span class="kw-2">&amp;</span>top_docs[..],
<span class="kw-2">&amp;</span>[
(<span class="number">40i64</span>, DocAddress::new(<span class="number">0</span>, <span class="number">1</span>)),
(-<span class="number">1i64</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>)),
]
);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_top_field_collector_f64() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>city = schema_builder.add_text_field(<span class="string">&quot;city&quot;</span>, TEXT);
<span class="kw">let </span>altitude = schema_builder.add_f64_field(<span class="string">&quot;altitude&quot;</span>, FAST);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
city =&gt; <span class="string">&quot;georgetown&quot;</span>,
altitude =&gt; -<span class="number">1.0f64</span>,
))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
city =&gt; <span class="string">&quot;tokyo&quot;</span>,
altitude =&gt; <span class="number">40f64</span>,
))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>top_collector = TopDocs::with_limit(<span class="number">3</span>).order_by_fast_field(altitude);
<span class="kw">let </span>top_docs: Vec&lt;(f64, DocAddress)&gt; = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>top_collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(
<span class="kw-2">&amp;</span>top_docs[..],
<span class="kw-2">&amp;</span>[
(<span class="number">40f64</span>, DocAddress::new(<span class="number">0</span>, <span class="number">1</span>)),
(-<span class="number">1.0f64</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>)),
]
);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">fn </span>test_field_does_not_exist() {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>title = schema_builder.add_text_field(TITLE, TEXT);
<span class="kw">let </span>size = schema_builder.add_u64_field(SIZE, FAST);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>(index, <span class="kw">_</span>) = index(<span class="string">&quot;beer&quot;</span>, title, schema, |index_writer| {
index_writer
.add_document(<span class="macro">doc!</span>(
title =&gt; <span class="string">&quot;bottle of beer&quot;</span>,
size =&gt; <span class="number">12u64</span>,
))
.unwrap();
});
<span class="kw">let </span>searcher = index.reader().unwrap().searcher();
<span class="kw">let </span>top_collector = TopDocs::with_limit(<span class="number">4</span>).order_by_u64_field(Field::from_field_id(<span class="number">2</span>));
<span class="kw">let </span>segment_reader = searcher.segment_reader(<span class="number">0u32</span>);
top_collector
.for_segment(<span class="number">0</span>, segment_reader)
.expect(<span class="string">&quot;should panic&quot;</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_field_not_fast_field() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>size = schema_builder.add_u64_field(SIZE, STORED);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(size=&gt;<span class="number">1u64</span>))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>segment = searcher.segment_reader(<span class="number">0</span>);
<span class="kw">let </span>top_collector = TopDocs::with_limit(<span class="number">4</span>).order_by_u64_field(size);
<span class="kw">let </span>err = top_collector.for_segment(<span class="number">0</span>, segment).err().unwrap();
<span class="macro">assert!</span>(<span class="macro">matches!</span>(err, <span class="kw">crate</span>::TantivyError::SchemaError(<span class="kw">_</span>)));
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_field_wrong_type() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>size = schema_builder.add_u64_field(SIZE, STORED);
<span class="kw">let </span>schema = schema_builder.build();
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(size=&gt;<span class="number">1u64</span>))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher();
<span class="kw">let </span>segment = searcher.segment_reader(<span class="number">0</span>);
<span class="kw">let </span>top_collector = TopDocs::with_limit(<span class="number">4</span>).order_by_fast_field::&lt;i64&gt;(size);
<span class="kw">let </span>err = top_collector.for_segment(<span class="number">0</span>, segment).err().unwrap();
<span class="macro">assert!</span>(
<span class="macro">matches!</span>(err, <span class="kw">crate</span>::TantivyError::SchemaError(msg) <span class="kw">if </span>msg == <span class="string">&quot;Field \&quot;size\&quot; is not a fast field.&quot;</span>)
);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_tweak_score_top_collector_with_offset() -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">let </span>index = make_index()<span class="question-mark">?</span>;
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;text&quot;</span>).unwrap();
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[field]);
<span class="kw">let </span>text_query = query_parser.parse_query(<span class="string">&quot;droopy tax&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>collector = TopDocs::with_limit(<span class="number">2</span>).and_offset(<span class="number">1</span>).tweak_score(
<span class="kw">move </span>|_segment_reader: <span class="kw-2">&amp;</span>SegmentReader| <span class="kw">move </span>|doc: DocId, _original_score: Score| doc,
);
<span class="kw">let </span>score_docs: Vec&lt;(u32, DocAddress)&gt; =
index.reader()<span class="question-mark">?</span>.searcher().search(<span class="kw-2">&amp;</span>text_query, <span class="kw-2">&amp;</span>collector)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(
score_docs,
<span class="macro">vec!</span>[(<span class="number">1</span>, DocAddress::new(<span class="number">0</span>, <span class="number">1</span>)), (<span class="number">0</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>)),]
);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_custom_score_top_collector_with_offset() {
<span class="kw">let </span>index = make_index().unwrap();
<span class="kw">let </span>field = index.schema().get_field(<span class="string">&quot;text&quot;</span>).unwrap();
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[field]);
<span class="kw">let </span>text_query = query_parser.parse_query(<span class="string">&quot;droopy tax&quot;</span>).unwrap();
<span class="kw">let </span>collector = TopDocs::with_limit(<span class="number">2</span>)
.and_offset(<span class="number">1</span>)
.custom_score(<span class="kw">move </span>|_segment_reader: <span class="kw-2">&amp;</span>SegmentReader| <span class="kw">move </span>|doc: DocId| doc);
<span class="kw">let </span>score_docs: Vec&lt;(u32, DocAddress)&gt; = index
.reader()
.unwrap()
.searcher()
.search(<span class="kw-2">&amp;</span>text_query, <span class="kw-2">&amp;</span>collector)
.unwrap();
<span class="macro">assert_eq!</span>(
score_docs,
<span class="macro">vec!</span>[(<span class="number">1</span>, DocAddress::new(<span class="number">0</span>, <span class="number">1</span>)), (<span class="number">0</span>, DocAddress::new(<span class="number">0</span>, <span class="number">0</span>)),]
);
}
<span class="kw">fn </span>index(
query: <span class="kw-2">&amp;</span>str,
query_field: Field,
schema: Schema,
<span class="kw-2">mut </span>doc_adder: <span class="kw">impl </span>FnMut(<span class="kw-2">&amp;mut </span>IndexWriter),
) -&gt; (Index, Box&lt;<span class="kw">dyn </span>Query&gt;) {
<span class="kw">let </span>index = Index::create_in_ram(schema);
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_with_num_threads(<span class="number">1</span>, <span class="number">10_000_000</span>).unwrap();
doc_adder(<span class="kw-2">&amp;mut </span>index_writer);
index_writer.commit().unwrap();
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[query_field]);
<span class="kw">let </span>query = query_parser.parse_query(query).unwrap();
(index, query)
}
}
</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>