| <!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="`CustomScorer` makes it possible to define any kind of score."><meta name="keywords" content="rust, rustlang, rust-lang, CustomScorer"><title>CustomScorer 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="#">CustomScorer</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.Child">Child</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.segment_scorer">segment_scorer</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="#">CustomScorer</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/custom_score_top_collector.rs.html#38-44">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 CustomScorer<TScore>: Sync { |
| type <a href="#associatedtype.Child" class="associatedtype">Child</a>: <a class="trait" href="trait.CustomSegmentScorer.html" title="trait tantivy::collector::CustomSegmentScorer">CustomSegmentScorer</a><TScore>; |
| |
| fn <a href="#tymethod.segment_scorer" class="fnname">segment_scorer</a>(<br> &self,<br> segment_reader: &<a class="struct" href="../struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a><br> ) -> <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a><Self::<a class="associatedtype" href="trait.CustomScorer.html#associatedtype.Child" title="type tantivy::collector::CustomScorer::Child">Child</a>>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>CustomScorer</code> makes it possible to define any kind of score.</p> |
| <p>The <code>CustomerScorer</code> itself does not make much of the computation itself. |
| Instead, it helps constructing <code>Self::Child</code> instances that will compute |
| the score at a segment scale.</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.Child" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/custom_score_top_collector.rs.html#40">source</a><h4 class="code-header">type <a href="#associatedtype.Child" class="associatedtype">Child</a>: <a class="trait" href="trait.CustomSegmentScorer.html" title="trait tantivy::collector::CustomSegmentScorer">CustomSegmentScorer</a><TScore></h4></section></summary><div class="docblock"><p>Type of the associated <a href="trait.CustomSegmentScorer.html" title="CustomSegmentScorer"><code>CustomSegmentScorer</code></a>.</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.segment_scorer" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/custom_score_top_collector.rs.html#43">source</a><h4 class="code-header">fn <a href="#tymethod.segment_scorer" class="fnname">segment_scorer</a>(&self, segment_reader: &<a class="struct" href="../struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a>) -> <a class="type" href="../type.Result.html" title="type tantivy::Result">Result</a><Self::<a class="associatedtype" href="trait.CustomScorer.html#associatedtype.Child" title="type tantivy::collector::CustomScorer::Child">Child</a>></h4></section></summary><div class="docblock"><p>Builds a child scorer for a specific segment. The child scorer is associated with |
| a specific segment.</p> |
| </div></details></div><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-CustomScorer%3CTScore%3E-for-F" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/custom_score_top_collector.rs.html#103-113">source</a><a href="#impl-CustomScorer%3CTScore%3E-for-F" class="anchor"></a><h3 class="code-header">impl<F, TScore, T> <a class="trait" href="trait.CustomScorer.html" title="trait tantivy::collector::CustomScorer">CustomScorer</a><TScore> for F<span class="where fmt-newline">where<br> F: 'static + Send + Sync + Fn(&<a class="struct" href="../struct.SegmentReader.html" title="struct tantivy::SegmentReader">SegmentReader</a>) -> T,<br> T: <a class="trait" href="trait.CustomSegmentScorer.html" title="trait tantivy::collector::CustomSegmentScorer">CustomSegmentScorer</a><TScore>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Child-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Child-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Child" class="associatedtype">Child</a> = T</h4></section></div></details></div><script src="../../implementors/tantivy/collector/custom_score_top_collector/trait.CustomScorer.js" 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> |
