| <!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="The `SegmentCollector` is the trait in charge of defining the collect operation at the scale of the segment."><meta name="keywords" content="rust, rustlang, rust-lang, SegmentCollector"><title>SegmentCollector in tantivy::collector - Rust</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="sidebar-items.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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><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><h2></h2></nav><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><h2 class="location"><a href="#">SegmentCollector</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Fruit">Fruit</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.collect">collect</a></li><li><a href="#tymethod.harvest">harvest</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-SegmentCollector-for-(Left%2C%20Right)">(Left, Right)</a></li><li><a href="#impl-SegmentCollector-for-(One%2C%20Two%2C%20Three)">(One, Two, Three)</a></li><li><a href="#impl-SegmentCollector-for-(One%2C%20Two%2C%20Three%2C%20Four)">(One, Two, Three, Four)</a></li><li><a href="#impl-SegmentCollector-for-Box%3Cdyn%20BoxableSegmentCollector%3E">Box<dyn BoxableSegmentCollector></a></li><li><a href="#impl-SegmentCollector-for-Option%3CTSegmentCollector%3E">Option<TSegmentCollector></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy::collector</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Trait <a href="../index.html">tantivy</a>::<wbr><a href="index.html">collector</a>::<wbr><a class="trait" href="#">SegmentCollector</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tantivy/collector/mod.rs.html#266-276">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SegmentCollector: 'static { |
| type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a>: <a class="trait" href="trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a>; |
| |
| fn <a href="#tymethod.collect" class="fnname">collect</a>(&mut self, doc: <a class="type" href="../type.DocId.html" title="type tantivy::DocId">DocId</a>, score: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>); |
| <span class="item-spacer"></span> fn <a href="#tymethod.harvest" class="fnname">harvest</a>(self) -> Self::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <code>SegmentCollector</code> is the trait in charge of defining the |
| collect operation at the scale of the segment.</p> |
| <p><code>.collect(doc, score)</code> will be called for every documents |
| matching the query.</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Fruit" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#269">source</a><h4 class="code-header">type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a>: <a class="trait" href="trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a></h4></section></summary><div class="docblock"><p><code>Fruit</code> is the type for the result of our collection. |
| e.g. <code>usize</code> for the <code>Count</code> collector.</p> |
| </div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.collect" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#272">source</a><h4 class="code-header">fn <a href="#tymethod.collect" class="fnname">collect</a>(&mut self, doc: <a class="type" href="../type.DocId.html" title="type tantivy::DocId">DocId</a>, score: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>)</h4></section></summary><div class="docblock"><p>The query pushes the scored document to the collector via this method.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.harvest" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#275">source</a><h4 class="code-header">fn <a href="#tymethod.harvest" class="fnname">harvest</a>(self) -> Self::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a></h4></section></summary><div class="docblock"><p>Extract the fruit of the collection from the <code>SegmentCollector</code>.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SegmentCollector-for-Box%3Cdyn%20BoxableSegmentCollector%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/multi_collector.rs.html#52-62">source</a><a href="#impl-SegmentCollector-for-Box%3Cdyn%20BoxableSegmentCollector%3E" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a> for Box<dyn BoxableSegmentCollector></h3></section></summary><div class="impl-items"><section id="associatedtype.Fruit-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Fruit-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a> = Box<dyn <a class="trait" href="trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a> + 'static, Global></h4></section><section id="method.collect" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/multi_collector.rs.html#55-57">source</a><a href="#method.collect" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.collect" class="fnname">collect</a>(&mut self, doc: u32, score: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>)</h4></section><section id="method.harvest" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/multi_collector.rs.html#59-61">source</a><a href="#method.harvest" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.harvest" class="fnname">harvest</a>(self) -> Box<dyn <a class="trait" href="trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a>></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SegmentCollector-for-Option%3CTSegmentCollector%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#206-218">source</a><a href="#impl-SegmentCollector-for-Option%3CTSegmentCollector%3E" class="anchor"></a><h3 class="code-header">impl<TSegmentCollector: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>> <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a> for Option<TSegmentCollector></h3></section></summary><div class="impl-items"><section id="associatedtype.Fruit-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Fruit-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a> = Option<<TSegmentCollector as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>></h4></section><section id="method.collect-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#209-213">source</a><a href="#method.collect-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.collect" class="fnname">collect</a>(&mut self, doc: <a class="type" href="../type.DocId.html" title="type tantivy::DocId">DocId</a>, score: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>)</h4></section><section id="method.harvest-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#215-217">source</a><a href="#method.harvest-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.harvest" class="fnname">harvest</a>(self) -> Self::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SegmentCollector-for-(Left%2C%20Right)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#320-335">source</a><a href="#impl-SegmentCollector-for-(Left%2C%20Right)" class="anchor"></a><h3 class="code-header">impl<Left, Right> <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a> for (Left, Right)<span class="where fmt-newline">where<br> Left: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,<br> Right: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Fruit-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Fruit-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a> = (<Left as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>, <Right as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>)</h4></section><section id="method.collect-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#327-330">source</a><a href="#method.collect-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.collect" class="fnname">collect</a>(&mut self, doc: <a class="type" href="../type.DocId.html" title="type tantivy::DocId">DocId</a>, score: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>)</h4></section><section id="method.harvest-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#332-334">source</a><a href="#method.harvest-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.harvest" class="fnname">harvest</a>(self) -> <Self as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SegmentCollector-for-(One%2C%20Two%2C%20Three)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#383-400">source</a><a href="#impl-SegmentCollector-for-(One%2C%20Two%2C%20Three)" class="anchor"></a><h3 class="code-header">impl<One, Two, Three> <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a> for (One, Two, Three)<span class="where fmt-newline">where<br> One: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,<br> Two: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,<br> Three: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Fruit-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Fruit-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a> = (<One as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>, <Two as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>, <Three as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>)</h4></section><section id="method.collect-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#391-395">source</a><a href="#method.collect-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.collect" class="fnname">collect</a>(&mut self, doc: <a class="type" href="../type.DocId.html" title="type tantivy::DocId">DocId</a>, score: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>)</h4></section><section id="method.harvest-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#397-399">source</a><a href="#method.harvest-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.harvest" class="fnname">harvest</a>(self) -> <Self as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SegmentCollector-for-(One%2C%20Two%2C%20Three%2C%20Four)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#456-480">source</a><a href="#impl-SegmentCollector-for-(One%2C%20Two%2C%20Three%2C%20Four)" class="anchor"></a><h3 class="code-header">impl<One, Two, Three, Four> <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a> for (One, Two, Three, Four)<span class="where fmt-newline">where<br> One: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,<br> Two: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,<br> Three: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,<br> Four: <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Fruit-5" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Fruit-5" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a> = (<One as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>, <Two as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>, <Three as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>, <Four as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a>)</h4></section><section id="method.collect-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#465-470">source</a><a href="#method.collect-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.collect" class="fnname">collect</a>(&mut self, doc: <a class="type" href="../type.DocId.html" title="type tantivy::DocId">DocId</a>, score: <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>)</h4></section><section id="method.harvest-4" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#472-479">source</a><a href="#method.harvest-4" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.harvest" class="fnname">harvest</a>(self) -> <Self as <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a>>::<a class="associatedtype" href="trait.SegmentCollector.html#associatedtype.Fruit" title="type tantivy::collector::SegmentCollector::Fruit">Fruit</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SegmentCollector-for-AggregationSegmentCollector" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/aggregation/collector.rs.html#164-186">source</a><a href="#impl-SegmentCollector-for-AggregationSegmentCollector" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SegmentCollector.html" title="trait tantivy::collector::SegmentCollector">SegmentCollector</a> for <a class="struct" href="../aggregation/struct.AggregationSegmentCollector.html" title="struct tantivy::aggregation::AggregationSegmentCollector">AggregationSegmentCollector</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Fruit-6" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Fruit-6" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Fruit" class="associatedtype">Fruit</a> = Result<<a class="struct" href="../aggregation/intermediate_agg_result/struct.IntermediateAggregationResults.html" title="struct tantivy::aggregation::intermediate_agg_result::IntermediateAggregationResults">IntermediateAggregationResults</a>, <a class="enum" href="../error/enum.TantivyError.html" title="enum tantivy::error::TantivyError">TantivyError</a>></h4></section></div></details></div><script src="../../implementors/tantivy/collector/trait.SegmentCollector.js" data-ignore-extern-crates="alloc,core" async></script></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> |
