Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tantivy / collector / facet_collector.rs.html
blob: ee649749dd25865c0641a5d30e539963251553de [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/facet_collector.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>facet_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>
</pre><pre class="rust"><code><span class="kw">use </span>std::cmp::Ordering;
<span class="kw">use </span>std::collections::{btree_map, BTreeMap, BTreeSet, BinaryHeap};
<span class="kw">use </span>std::iter::Peekable;
<span class="kw">use </span>std::ops::Bound;
<span class="kw">use </span>std::{u64, usize};
<span class="kw">use </span><span class="kw">crate</span>::collector::{Collector, SegmentCollector};
<span class="kw">use </span><span class="kw">crate</span>::fastfield::FacetReader;
<span class="kw">use </span><span class="kw">crate</span>::schema::{Facet, Field};
<span class="kw">use crate</span>::{DocId, Score, SegmentOrdinal, SegmentReader};
<span class="kw">struct </span>Hit&lt;<span class="lifetime">&#39;a</span>&gt; {
count: u64,
facet: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Facet,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Eq <span class="kw">for </span>Hit&lt;<span class="lifetime">&#39;a</span>&gt; {}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; PartialEq&lt;Hit&lt;<span class="lifetime">&#39;a</span>&gt;&gt; <span class="kw">for </span>Hit&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>Hit&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; bool {
<span class="self">self</span>.count == other.count
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; PartialOrd&lt;Hit&lt;<span class="lifetime">&#39;a</span>&gt;&gt; <span class="kw">for </span>Hit&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>partial_cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>Hit&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;Ordering&gt; {
<span class="prelude-val">Some</span>(<span class="self">self</span>.cmp(other))
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Ord <span class="kw">for </span>Hit&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; Ordering {
other
.count
.cmp(<span class="kw-2">&amp;</span><span class="self">self</span>.count)
.then(<span class="self">self</span>.facet.cmp(other.facet))
}
}
<span class="kw">fn </span>facet_depth(facet_bytes: <span class="kw-2">&amp;</span>[u8]) -&gt; usize {
<span class="kw">if </span>facet_bytes.is_empty() {
<span class="number">0
</span>} <span class="kw">else </span>{
facet_bytes.iter().cloned().filter(|b| <span class="kw-2">*</span>b == <span class="number">0u8</span>).count() + <span class="number">1
</span>}
}
<span class="doccomment">/// Collector for faceting
///
/// The collector collects all facets. You need to configure it
/// beforehand with the facet you want to extract.
///
/// This is done by calling `.add_facet(...)` with the root of the
/// facet you want to extract as argument.
///
/// Facet counts will only be computed for the facet that are direct children
/// of such a root facet.
///
/// For instance, if your index represents books, your hierarchy of facets
/// may contain `category`, `language`.
///
/// The category facet may include `subcategories`. For instance, a book
/// could belong to `/category/fiction/fantasy`.
///
/// If you request the facet counts for `/category`, the result will be
/// the breakdown of counts for the direct children of `/category`
/// (e.g. `/category/fiction`, `/category/biography`, `/category/personal_development`).
///
/// Once collection is finished, you can harvest its results in the form
/// of a [`FacetCounts`] object, and extract your facet counts from it.
///
/// This implementation assumes you are working with a number of facets that
/// is many hundreds of times smaller than your number of documents.
///
///
/// ```rust
/// use tantivy::collector::FacetCollector;
/// use tantivy::query::AllQuery;
/// use tantivy::schema::{Facet, Schema, FacetOptions, TEXT};
/// use tantivy::{doc, Index};
///
/// fn example() -&gt; tantivy::Result&lt;()&gt; {
/// let mut schema_builder = Schema::builder();
///
/// // Facet have their own specific type.
/// // It is not a bad practise to put all of your
/// // facet information in the same field.
/// let facet = schema_builder.add_facet_field(&quot;facet&quot;, FacetOptions::default());
/// 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(3_000_000)?;
/// // a document can be associated with any number of facets
/// index_writer.add_document(doc!(
/// title =&gt; &quot;The Name of the Wind&quot;,
/// facet =&gt; Facet::from(&quot;/lang/en&quot;),
/// facet =&gt; Facet::from(&quot;/category/fiction/fantasy&quot;)
/// ))?;
/// index_writer.add_document(doc!(
/// title =&gt; &quot;Dune&quot;,
/// facet =&gt; Facet::from(&quot;/lang/en&quot;),
/// facet =&gt; Facet::from(&quot;/category/fiction/sci-fi&quot;)
/// ))?;
/// index_writer.add_document(doc!(
/// title =&gt; &quot;La Vénus d&#39;Ille&quot;,
/// facet =&gt; Facet::from(&quot;/lang/fr&quot;),
/// facet =&gt; Facet::from(&quot;/category/fiction/fantasy&quot;),
/// facet =&gt; Facet::from(&quot;/category/fiction/horror&quot;)
/// ))?;
/// index_writer.add_document(doc!(
/// title =&gt; &quot;The Diary of a Young Girl&quot;,
/// facet =&gt; Facet::from(&quot;/lang/en&quot;),
/// facet =&gt; Facet::from(&quot;/category/biography&quot;)
/// ))?;
/// index_writer.commit()?;
/// }
/// let reader = index.reader()?;
/// let searcher = reader.searcher();
///
/// {
/// let mut facet_collector = FacetCollector::for_field(facet);
/// facet_collector.add_facet(&quot;/lang&quot;);
/// facet_collector.add_facet(&quot;/category&quot;);
/// let facet_counts = searcher.search(&amp;AllQuery, &amp;facet_collector)?;
///
/// // This lists all of the facet counts
/// let facets: Vec&lt;(&amp;Facet, u64)&gt; = facet_counts
/// .get(&quot;/category&quot;)
/// .collect();
/// assert_eq!(facets, vec![
/// (&amp;Facet::from(&quot;/category/biography&quot;), 1),
/// (&amp;Facet::from(&quot;/category/fiction&quot;), 3)
/// ]);
/// }
///
/// {
/// let mut facet_collector = FacetCollector::for_field(facet);
/// facet_collector.add_facet(&quot;/category/fiction&quot;);
/// let facet_counts = searcher.search(&amp;AllQuery, &amp;facet_collector)?;
///
/// // This lists all of the facet counts
/// let facets: Vec&lt;(&amp;Facet, u64)&gt; = facet_counts
/// .get(&quot;/category/fiction&quot;)
/// .collect();
/// assert_eq!(facets, vec![
/// (&amp;Facet::from(&quot;/category/fiction/fantasy&quot;), 2),
/// (&amp;Facet::from(&quot;/category/fiction/horror&quot;), 1),
/// (&amp;Facet::from(&quot;/category/fiction/sci-fi&quot;), 1)
/// ]);
/// }
///
/// {
/// let mut facet_collector = FacetCollector::for_field(facet);
/// facet_collector.add_facet(&quot;/category/fiction&quot;);
/// let facet_counts = searcher.search(&amp;AllQuery, &amp;facet_collector)?;
///
/// // This lists all of the facet counts
/// let facets: Vec&lt;(&amp;Facet, u64)&gt; = facet_counts.top_k(&quot;/category/fiction&quot;, 1);
/// assert_eq!(facets, vec![
/// (&amp;Facet::from(&quot;/category/fiction/fantasy&quot;), 2)
/// ]);
/// }
///
/// Ok(())
/// }
/// # assert!(example().is_ok());
/// ```
</span><span class="kw">pub struct </span>FacetCollector {
field: Field,
facets: BTreeSet&lt;Facet&gt;,
}
<span class="kw">pub struct </span>FacetSegmentCollector {
reader: FacetReader,
facet_ords_buf: Vec&lt;u64&gt;,
<span class="comment">// facet_ord -&gt; collapse facet_id
</span>collapse_mapping: Vec&lt;usize&gt;,
<span class="comment">// collapse facet_id -&gt; count
</span>counts: Vec&lt;u64&gt;,
<span class="comment">// collapse facet_id -&gt; facet_ord
</span>collapse_facet_ords: Vec&lt;u64&gt;,
}
<span class="kw">enum </span>SkipResult {
Found,
NotFound,
}
<span class="kw">fn </span>skip&lt;<span class="lifetime">&#39;a</span>, I: Iterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Facet&gt;&gt;(
target: <span class="kw-2">&amp;</span>[u8],
collapse_it: <span class="kw-2">&amp;mut </span>Peekable&lt;I&gt;,
) -&gt; SkipResult {
<span class="kw">loop </span>{
<span class="kw">match </span>collapse_it.peek() {
<span class="prelude-val">Some</span>(facet_bytes) =&gt; <span class="kw">match </span>facet_bytes.encoded_str().as_bytes().cmp(target) {
Ordering::Less =&gt; {}
Ordering::Greater =&gt; {
<span class="kw">return </span>SkipResult::NotFound;
}
Ordering::Equal =&gt; {
<span class="kw">return </span>SkipResult::Found;
}
},
<span class="prelude-val">None </span>=&gt; {
<span class="kw">return </span>SkipResult::NotFound;
}
}
collapse_it.next();
}
}
<span class="kw">impl </span>FacetCollector {
<span class="doccomment">/// Create a facet collector to collect the facets
/// from a specific facet `Field`.
///
/// This function does not check whether the field
/// is of the proper type.
</span><span class="kw">pub fn </span>for_field(field: Field) -&gt; FacetCollector {
FacetCollector {
field,
facets: BTreeSet::default(),
}
}
<span class="doccomment">/// Adds a facet that we want to record counts
///
/// Adding facet `Facet::from(&quot;/country&quot;)` for instance,
/// will record the counts of all of the direct children of the facet country
/// (e.g. `/country/FR`, `/country/UK`).
///
/// Adding two facets within which one is the prefix of the other is forbidden.
/// If you need the correct number of unique documents for two such facets,
/// just add them in a separate `FacetCollector`.
</span><span class="kw">pub fn </span>add_facet&lt;T&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, facet_from: T)
<span class="kw">where </span>Facet: From&lt;T&gt; {
<span class="kw">let </span>facet = Facet::from(facet_from);
<span class="kw">for </span>old_facet <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.facets {
<span class="macro">assert!</span>(
!old_facet.is_prefix_of(<span class="kw-2">&amp;</span>facet),
<span class="string">&quot;Tried to add a facet which is a descendant of an already added facet.&quot;
</span>);
<span class="macro">assert!</span>(
!facet.is_prefix_of(old_facet),
<span class="string">&quot;Tried to add a facet which is an ancestor of an already added facet.&quot;
</span>);
}
<span class="self">self</span>.facets.insert(facet);
}
}
<span class="kw">impl </span>Collector <span class="kw">for </span>FacetCollector {
<span class="kw">type </span>Fruit = FacetCounts;
<span class="kw">type </span>Child = FacetSegmentCollector;
<span class="kw">fn </span>for_segment(
<span class="kw-2">&amp;</span><span class="self">self</span>,
<span class="kw">_</span>: SegmentOrdinal,
reader: <span class="kw-2">&amp;</span>SegmentReader,
) -&gt; <span class="kw">crate</span>::Result&lt;FacetSegmentCollector&gt; {
<span class="kw">let </span>facet_reader = reader.facet_reader(<span class="self">self</span>.field)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>collapse_mapping = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>counts = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>collapse_facet_ords = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>collapse_facet_it = <span class="self">self</span>.facets.iter().peekable();
collapse_facet_ords.push(<span class="number">0</span>);
{
<span class="kw">let </span><span class="kw-2">mut </span>facet_streamer = facet_reader.facet_dict().range().into_stream()<span class="question-mark">?</span>;
<span class="kw">if </span>facet_streamer.advance() {
<span class="lifetime">&#39;outer</span>: <span class="kw">loop </span>{
<span class="comment">// at the beginning of this loop, facet_streamer
// is positioned on a term that has not been processed yet.
</span><span class="kw">let </span>skip_result = skip(facet_streamer.key(), <span class="kw-2">&amp;mut </span>collapse_facet_it);
<span class="kw">match </span>skip_result {
SkipResult::Found =&gt; {
<span class="comment">// we reach a facet we decided to collapse.
</span><span class="kw">let </span>collapse_depth = facet_depth(facet_streamer.key());
<span class="kw">let </span><span class="kw-2">mut </span>collapsed_id = <span class="number">0</span>;
collapse_mapping.push(<span class="number">0</span>);
<span class="kw">while </span>facet_streamer.advance() {
<span class="kw">let </span>depth = facet_depth(facet_streamer.key());
<span class="kw">if </span>depth &lt;= collapse_depth {
<span class="kw">continue </span><span class="lifetime">&#39;outer</span>;
}
<span class="kw">if </span>depth == collapse_depth + <span class="number">1 </span>{
collapsed_id = collapse_facet_ords.len();
collapse_facet_ords.push(facet_streamer.term_ord());
}
collapse_mapping.push(collapsed_id);
}
<span class="kw">break</span>;
}
SkipResult::NotFound =&gt; {
collapse_mapping.push(<span class="number">0</span>);
<span class="kw">if </span>!facet_streamer.advance() {
<span class="kw">break</span>;
}
}
}
}
}
}
counts.resize(collapse_facet_ords.len(), <span class="number">0</span>);
<span class="prelude-val">Ok</span>(FacetSegmentCollector {
reader: facet_reader,
facet_ords_buf: Vec::with_capacity(<span class="number">255</span>),
collapse_mapping,
counts,
collapse_facet_ords,
})
}
<span class="kw">fn </span>requires_scoring(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="bool-val">false
</span>}
<span class="kw">fn </span>merge_fruits(<span class="kw-2">&amp;</span><span class="self">self</span>, segments_facet_counts: Vec&lt;FacetCounts&gt;) -&gt; <span class="kw">crate</span>::Result&lt;FacetCounts&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>facet_counts: BTreeMap&lt;Facet, u64&gt; = BTreeMap::new();
<span class="kw">for </span>segment_facet_counts <span class="kw">in </span>segments_facet_counts {
<span class="kw">for </span>(facet, count) <span class="kw">in </span>segment_facet_counts.facet_counts {
<span class="kw-2">*</span>(facet_counts.entry(facet).or_insert(<span class="number">0</span>)) += count;
}
}
<span class="prelude-val">Ok</span>(FacetCounts { facet_counts })
}
}
<span class="kw">impl </span>SegmentCollector <span class="kw">for </span>FacetSegmentCollector {
<span class="kw">type </span>Fruit = FacetCounts;
<span class="kw">fn </span>collect(<span class="kw-2">&amp;mut </span><span class="self">self</span>, doc: DocId, <span class="kw">_</span>: Score) {
<span class="self">self</span>.reader.facet_ords(doc, <span class="kw-2">&amp;mut </span><span class="self">self</span>.facet_ords_buf);
<span class="kw">let </span><span class="kw-2">mut </span>previous_collapsed_ord: usize = usize::MAX;
<span class="kw">for </span><span class="kw-2">&amp;</span>facet_ord <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.facet_ords_buf {
<span class="kw">let </span>collapsed_ord = <span class="self">self</span>.collapse_mapping[facet_ord <span class="kw">as </span>usize];
<span class="self">self</span>.counts[collapsed_ord] += u64::from(collapsed_ord != previous_collapsed_ord);
previous_collapsed_ord = collapsed_ord;
}
}
<span class="doccomment">/// Returns the results of the collection.
///
/// This method does not just return the counters,
/// it also translates the facet ordinals of the last segment.
</span><span class="kw">fn </span>harvest(<span class="self">self</span>) -&gt; FacetCounts {
<span class="kw">let </span><span class="kw-2">mut </span>facet_counts = BTreeMap::new();
<span class="kw">let </span>facet_dict = <span class="self">self</span>.reader.facet_dict();
<span class="kw">for </span>(collapsed_facet_ord, count) <span class="kw">in </span><span class="self">self</span>.counts.iter().cloned().enumerate() {
<span class="kw">if </span>count == <span class="number">0 </span>{
<span class="kw">continue</span>;
}
<span class="kw">let </span><span class="kw-2">mut </span>facet = <span class="macro">vec!</span>[];
<span class="kw">let </span>facet_ord = <span class="self">self</span>.collapse_facet_ords[collapsed_facet_ord];
<span class="comment">// TODO handle errors.
</span><span class="kw">if </span>facet_dict.ord_to_term(facet_ord <span class="kw">as </span>u64, <span class="kw-2">&amp;mut </span>facet).is_ok() {
<span class="kw">if let </span><span class="prelude-val">Ok</span>(facet) = Facet::from_encoded(facet) {
facet_counts.insert(facet, count);
}
}
}
FacetCounts { facet_counts }
}
}
<span class="doccomment">/// Intermediary result of the `FacetCollector` that stores
/// the facet counts for all the segments.
</span><span class="kw">pub struct </span>FacetCounts {
facet_counts: BTreeMap&lt;Facet, u64&gt;,
}
<span class="kw">pub struct </span>FacetChildIterator&lt;<span class="lifetime">&#39;a</span>&gt; {
underlying: btree_map::Range&lt;<span class="lifetime">&#39;a</span>, Facet, u64&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Iterator <span class="kw">for </span>FacetChildIterator&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">type </span>Item = (<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Facet, u64);
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt; {
<span class="self">self</span>.underlying.next().map(|(facet, count)| (facet, <span class="kw-2">*</span>count))
}
}
<span class="kw">impl </span>FacetCounts {
<span class="doccomment">/// Returns an iterator over all of the facet count pairs inside this result.
/// See the documentation for [`FacetCollector`] for a usage example.
</span><span class="kw">pub fn </span>get&lt;T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, facet_from: T) -&gt; FacetChildIterator&lt;<span class="lifetime">&#39;_</span>&gt;
<span class="kw">where </span>Facet: From&lt;T&gt; {
<span class="kw">let </span>facet = Facet::from(facet_from);
<span class="kw">let </span>left_bound = Bound::Excluded(facet.clone());
<span class="kw">let </span>right_bound = <span class="kw">if </span>facet.is_root() {
Bound::Unbounded
} <span class="kw">else </span>{
<span class="kw">let </span><span class="kw-2">mut </span>facet_after_bytes: String = facet.encoded_str().to_owned();
facet_after_bytes.push(<span class="string">&#39;\u{1}&#39;</span>);
<span class="kw">let </span>facet_after = Facet::from_encoded_string(facet_after_bytes);
Bound::Excluded(facet_after)
};
<span class="kw">let </span>underlying: btree_map::Range&lt;<span class="lifetime">&#39;_</span>, <span class="kw">_</span>, <span class="kw">_</span>&gt; =
<span class="self">self</span>.facet_counts.range((left_bound, right_bound));
FacetChildIterator { underlying }
}
<span class="doccomment">/// Returns a vector of top `k` facets with their counts, sorted highest-to-lowest by counts.
/// See the documentation for [`FacetCollector`] for a usage example.
</span><span class="kw">pub fn </span>top_k&lt;T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, facet: T, k: usize) -&gt; Vec&lt;(<span class="kw-2">&amp;</span>Facet, u64)&gt;
<span class="kw">where </span>Facet: From&lt;T&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>heap = BinaryHeap::with_capacity(k);
<span class="kw">let </span><span class="kw-2">mut </span>it = <span class="self">self</span>.get(facet);
<span class="comment">// push the first k elements to first bring the heap
// to capacity
</span><span class="kw">for </span>(facet, count) <span class="kw">in </span>(<span class="kw-2">&amp;mut </span>it).take(k) {
heap.push(Hit { count, facet });
}
<span class="kw">let </span><span class="kw-2">mut </span>lowest_count: u64 = heap.peek().map(|hit| hit.count).unwrap_or(u64::MIN); <span class="comment">//&lt; the `unwrap_or` case may be triggered but the value
// is never used in that case.
</span><span class="kw">for </span>(facet, count) <span class="kw">in </span>it {
<span class="kw">if </span>count &gt; lowest_count {
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">mut </span>head) = heap.peek_mut() {
<span class="kw-2">*</span>head = Hit { count, facet };
}
<span class="comment">// the heap gets reconstructed at this point
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(head) = heap.peek() {
lowest_count = head.count;
}
}
}
heap.into_sorted_vec()
.into_iter()
.map(|hit| (hit.facet, hit.count))
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;()
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::iter;
<span class="kw">use </span>rand::distributions::Uniform;
<span class="kw">use </span>rand::prelude::SliceRandom;
<span class="kw">use </span>rand::{thread_rng, Rng};
<span class="kw">use super</span>::{FacetCollector, FacetCounts};
<span class="kw">use </span><span class="kw">crate</span>::collector::Count;
<span class="kw">use </span><span class="kw">crate</span>::core::Index;
<span class="kw">use </span><span class="kw">crate</span>::query::{AllQuery, QueryParser, TermQuery};
<span class="kw">use </span><span class="kw">crate</span>::schema::{Document, Facet, FacetOptions, Field, IndexRecordOption, Schema};
<span class="kw">use </span><span class="kw">crate</span>::Term;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_facet_collector_drilldown() -&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>facet_field = schema_builder.add_facet_field(<span class="string">&quot;facet&quot;</span>, FacetOptions::default());
<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>num_facets: usize = <span class="number">3 </span>* <span class="number">4 </span>* <span class="number">5</span>;
<span class="kw">let </span>facets: Vec&lt;Facet&gt; = (<span class="number">0</span>..num_facets)
.map(|<span class="kw-2">mut </span>n| {
<span class="kw">let </span>top = n % <span class="number">3</span>;
n /= <span class="number">3</span>;
<span class="kw">let </span>mid = n % <span class="number">4</span>;
n /= <span class="number">4</span>;
<span class="kw">let </span>leaf = n % <span class="number">5</span>;
Facet::from(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">&quot;/top{}/mid{}/leaf{}&quot;</span>, top, mid, leaf))
})
.collect();
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..num_facets * <span class="number">10 </span>{
<span class="kw">let </span><span class="kw-2">mut </span>doc = Document::new();
doc.add_facet(facet_field, facets[i % num_facets].clone());
index_writer.add_document(doc)<span class="question-mark">?</span>;
}
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = reader.searcher();
<span class="kw">let </span><span class="kw-2">mut </span>facet_collector = FacetCollector::for_field(facet_field);
facet_collector.add_facet(Facet::from(<span class="string">&quot;/top1&quot;</span>));
<span class="kw">let </span>counts = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>facet_collector)<span class="question-mark">?</span>;
{
<span class="kw">let </span>facets: Vec&lt;(String, u64)&gt; = counts
.get(<span class="string">&quot;/top1&quot;</span>)
.map(|(facet, count)| (facet.to_string(), count))
.collect();
<span class="macro">assert_eq!</span>(
facets,
[
(<span class="string">&quot;/top1/mid0&quot;</span>, <span class="number">50</span>),
(<span class="string">&quot;/top1/mid1&quot;</span>, <span class="number">50</span>),
(<span class="string">&quot;/top1/mid2&quot;</span>, <span class="number">50</span>),
(<span class="string">&quot;/top1/mid3&quot;</span>, <span class="number">50</span>),
]
.iter()
.map(|<span class="kw-2">&amp;</span>(facet_str, count)| (String::from(facet_str), count))
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;()
);
}
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
#[should_panic(
expected = <span class="string">&quot;Tried to add a facet which is a descendant of an already added facet.&quot;
</span>)]
</span><span class="kw">fn </span>test_misused_facet_collector() {
<span class="kw">let </span><span class="kw-2">mut </span>facet_collector = FacetCollector::for_field(Field::from_field_id(<span class="number">0</span>));
facet_collector.add_facet(Facet::from(<span class="string">&quot;/country&quot;</span>));
facet_collector.add_facet(Facet::from(<span class="string">&quot;/country/europe&quot;</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_doc_unsorted_multifacet() -&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>facet_field = schema_builder.add_facet_field(<span class="string">&quot;facets&quot;</span>, FacetOptions::default());
<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>(
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/subjects/A/a&quot;</span>).unwrap(),
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/subjects/B/a&quot;</span>).unwrap(),
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/subjects/A/b&quot;</span>).unwrap(),
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/subjects/B/b&quot;</span>).unwrap(),
))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = reader.searcher();
<span class="macro">assert_eq!</span>(searcher.num_docs(), <span class="number">1</span>);
<span class="kw">let </span><span class="kw-2">mut </span>facet_collector = FacetCollector::for_field(facet_field);
facet_collector.add_facet(<span class="string">&quot;/subjects&quot;</span>);
<span class="kw">let </span>counts = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>facet_collector)<span class="question-mark">?</span>;
<span class="kw">let </span>facets: Vec&lt;(<span class="kw-2">&amp;</span>Facet, u64)&gt; = counts.get(<span class="string">&quot;/subjects&quot;</span>).collect();
<span class="macro">assert_eq!</span>(facets[<span class="number">0</span>].<span class="number">1</span>, <span class="number">1</span>);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_doc_search_by_facet() -&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>facet_field = schema_builder.add_facet_field(<span class="string">&quot;facet&quot;</span>, FacetOptions::default());
<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>(
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/A/A&quot;</span>).unwrap(),
))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/A/B&quot;</span>).unwrap(),
))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/A/C/A&quot;</span>).unwrap(),
))<span class="question-mark">?</span>;
index_writer.add_document(<span class="macro">doc!</span>(
facet_field =&gt; Facet::from_text(<span class="kw-2">&amp;</span><span class="string">&quot;/D/C/A&quot;</span>).unwrap(),
))<span class="question-mark">?</span>;
index_writer.commit()<span class="question-mark">?</span>;
<span class="kw">let </span>reader = index.reader()<span class="question-mark">?</span>;
<span class="kw">let </span>searcher = reader.searcher();
<span class="macro">assert_eq!</span>(searcher.num_docs(), <span class="number">4</span>);
<span class="kw">let </span>count_facet = |facet_str: <span class="kw-2">&amp;</span>str| {
<span class="kw">let </span>term = Term::from_facet(facet_field, <span class="kw-2">&amp;</span>Facet::from_text(facet_str).unwrap());
searcher
.search(<span class="kw-2">&amp;</span>TermQuery::new(term, IndexRecordOption::Basic), <span class="kw-2">&amp;</span>Count)
.unwrap()
};
<span class="macro">assert_eq!</span>(count_facet(<span class="string">&quot;/&quot;</span>), <span class="number">4</span>);
<span class="macro">assert_eq!</span>(count_facet(<span class="string">&quot;/A&quot;</span>), <span class="number">3</span>);
<span class="macro">assert_eq!</span>(count_facet(<span class="string">&quot;/A/B&quot;</span>), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(count_facet(<span class="string">&quot;/A/C&quot;</span>), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(count_facet(<span class="string">&quot;/A/C/A&quot;</span>), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(count_facet(<span class="string">&quot;/C/A&quot;</span>), <span class="number">0</span>);
<span class="kw">let </span>query_parser = QueryParser::for_index(<span class="kw-2">&amp;</span>index, <span class="macro">vec!</span>[]);
{
<span class="kw">let </span>query = query_parser.parse_query(<span class="string">&quot;facet:/A/B&quot;</span>)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(<span class="number">1</span>, searcher.search(<span class="kw-2">&amp;</span>query, <span class="kw-2">&amp;</span>Count).unwrap());
}
{
<span class="kw">let </span>query = query_parser.parse_query(<span class="string">&quot;facet:/A&quot;</span>)<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(<span class="number">3</span>, searcher.search(<span class="kw-2">&amp;</span>query, <span class="kw-2">&amp;</span>Count)<span class="question-mark">?</span>);
}
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_non_used_facet_collector() {
<span class="kw">let </span><span class="kw-2">mut </span>facet_collector = FacetCollector::for_field(Field::from_field_id(<span class="number">0</span>));
facet_collector.add_facet(Facet::from(<span class="string">&quot;/country&quot;</span>));
facet_collector.add_facet(Facet::from(<span class="string">&quot;/countryeurope&quot;</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_facet_collector_topk() {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>facet_field = schema_builder.add_facet_field(<span class="string">&quot;facet&quot;</span>, FacetOptions::default());
<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>uniform = Uniform::new_inclusive(<span class="number">1</span>, <span class="number">100_000</span>);
<span class="kw">let </span><span class="kw-2">mut </span>docs: Vec&lt;Document&gt; = <span class="macro">vec!</span>[(<span class="string">&quot;a&quot;</span>, <span class="number">10</span>), (<span class="string">&quot;b&quot;</span>, <span class="number">100</span>), (<span class="string">&quot;c&quot;</span>, <span class="number">7</span>), (<span class="string">&quot;d&quot;</span>, <span class="number">12</span>), (<span class="string">&quot;e&quot;</span>, <span class="number">21</span>)]
.into_iter()
.flat_map(|(c, count)| {
<span class="kw">let </span>facet = Facet::from(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">&quot;/facet/{}&quot;</span>, c));
<span class="kw">let </span>doc = <span class="macro">doc!</span>(facet_field =&gt; facet);
iter::repeat(doc).take(count)
})
.map(|<span class="kw-2">mut </span>doc| {
doc.add_facet(
facet_field,
<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">&quot;/facet/{}&quot;</span>, thread_rng().sample(uniform)),
);
doc
})
.collect();
docs[..].shuffle(<span class="kw-2">&amp;mut </span>thread_rng());
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests().unwrap();
<span class="kw">for </span>doc <span class="kw">in </span>docs {
index_writer.add_document(doc).unwrap();
}
index_writer.commit().unwrap();
<span class="kw">let </span>searcher = index.reader().unwrap().searcher();
<span class="kw">let </span><span class="kw-2">mut </span>facet_collector = FacetCollector::for_field(facet_field);
facet_collector.add_facet(<span class="string">&quot;/facet&quot;</span>);
<span class="kw">let </span>counts: FacetCounts = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>facet_collector).unwrap();
{
<span class="kw">let </span>facets: Vec&lt;(<span class="kw-2">&amp;</span>Facet, u64)&gt; = counts.top_k(<span class="string">&quot;/facet&quot;</span>, <span class="number">3</span>);
<span class="macro">assert_eq!</span>(
facets,
<span class="macro">vec!</span>[
(<span class="kw-2">&amp;</span>Facet::from(<span class="string">&quot;/facet/b&quot;</span>), <span class="number">100</span>),
(<span class="kw-2">&amp;</span>Facet::from(<span class="string">&quot;/facet/e&quot;</span>), <span class="number">21</span>),
(<span class="kw-2">&amp;</span>Facet::from(<span class="string">&quot;/facet/d&quot;</span>), <span class="number">12</span>),
]
);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_facet_collector_topk_tie_break() -&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>facet_field = schema_builder.add_facet_field(<span class="string">&quot;facet&quot;</span>, FacetOptions::default());
<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>docs: Vec&lt;Document&gt; = <span class="macro">vec!</span>[(<span class="string">&quot;b&quot;</span>, <span class="number">2</span>), (<span class="string">&quot;a&quot;</span>, <span class="number">2</span>), (<span class="string">&quot;c&quot;</span>, <span class="number">4</span>)]
.into_iter()
.flat_map(|(c, count)| {
<span class="kw">let </span>facet = Facet::from(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">&quot;/facet/{}&quot;</span>, c));
<span class="kw">let </span>doc = <span class="macro">doc!</span>(facet_field =&gt; facet);
iter::repeat(doc).take(count)
})
.collect();
<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">for </span>doc <span class="kw">in </span>docs {
index_writer.add_document(doc)<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><span class="kw-2">mut </span>facet_collector = FacetCollector::for_field(facet_field);
facet_collector.add_facet(<span class="string">&quot;/facet&quot;</span>);
<span class="kw">let </span>counts: FacetCounts = searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>facet_collector)<span class="question-mark">?</span>;
<span class="kw">let </span>facets: Vec&lt;(<span class="kw-2">&amp;</span>Facet, u64)&gt; = counts.top_k(<span class="string">&quot;/facet&quot;</span>, <span class="number">2</span>);
<span class="macro">assert_eq!</span>(
facets,
<span class="macro">vec!</span>[(<span class="kw-2">&amp;</span>Facet::from(<span class="string">&quot;/facet/c&quot;</span>), <span class="number">4</span>), (<span class="kw-2">&amp;</span>Facet::from(<span class="string">&quot;/facet/a&quot;</span>), <span class="number">2</span>)]
);
<span class="prelude-val">Ok</span>(())
}
}
<span class="attribute">#[cfg(all(test, feature = <span class="string">&quot;unstable&quot;</span>))]
</span><span class="kw">mod </span>bench {
<span class="kw">use </span>rand::seq::SliceRandom;
<span class="kw">use </span>rand::thread_rng;
<span class="kw">use </span>test::Bencher;
<span class="kw">use </span><span class="kw">crate</span>::collector::FacetCollector;
<span class="kw">use </span><span class="kw">crate</span>::query::AllQuery;
<span class="kw">use </span><span class="kw">crate</span>::schema::{Facet, Schema, INDEXED};
<span class="kw">use </span><span class="kw">crate</span>::Index;
<span class="attribute">#[bench]
</span><span class="kw">fn </span>bench_facet_collector(b: <span class="kw-2">&amp;mut </span>Bencher) {
<span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder();
<span class="kw">let </span>facet_field = schema_builder.add_facet_field(<span class="string">&quot;facet&quot;</span>, INDEXED);
<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>docs = <span class="macro">vec!</span>[];
<span class="kw">for </span>val <span class="kw">in </span><span class="number">0</span>..<span class="number">50 </span>{
<span class="kw">let </span>facet = Facet::from(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">&quot;/facet_{}&quot;</span>, val));
<span class="kw">for _ in </span><span class="number">0</span>..val * val {
docs.push(<span class="macro">doc!</span>(facet_field=&gt;facet.clone()));
}
}
<span class="comment">// 40425 docs
</span>docs[..].shuffle(<span class="kw-2">&amp;mut </span>thread_rng());
<span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests().unwrap();
<span class="kw">for </span>doc <span class="kw">in </span>docs {
index_writer.add_document(doc).unwrap();
}
index_writer.commit().unwrap();
<span class="kw">let </span>reader = index.reader().unwrap();
b.iter(|| {
<span class="kw">let </span>searcher = reader.searcher();
<span class="kw">let </span>facet_collector = FacetCollector::for_field(facet_field);
searcher.search(<span class="kw-2">&amp;</span>AllQuery, <span class="kw-2">&amp;</span>facet_collector).unwrap();
});
}
}
</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>