| <!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 `MergePolicy` defines which segments should be merged."><meta name="keywords" content="rust, rustlang, rust-lang, MergePolicy"><title>MergePolicy in tantivy::merge_policy - 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="#">MergePolicy</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.compute_merge_candidates">compute_merge_candidates</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy::merge_policy</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">merge_policy</a>::<wbr><a class="trait" href="#">MergePolicy</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/indexer/merge_policy.rs.html#14-20">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 MergePolicy: Send + Sync + Debug { |
| fn <a href="#tymethod.compute_merge_candidates" class="fnname">compute_merge_candidates</a>(<br> &self,<br> segments: &[<a class="struct" href="../struct.SegmentMeta.html" title="struct tantivy::SegmentMeta">SegmentMeta</a>]<br> ) -> Vec<<a class="struct" href="struct.MergeCandidate.html" title="struct tantivy::merge_policy::MergeCandidate">MergeCandidate</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>MergePolicy</code> defines which segments should be merged.</p> |
| <p>Every time the list of segments changes, the segment updater |
| asks the merge policy if some segments should be merged.</p> |
| </div></details><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.compute_merge_candidates" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/indexer/merge_policy.rs.html#19">source</a><h4 class="code-header">fn <a href="#tymethod.compute_merge_candidates" class="fnname">compute_merge_candidates</a>(<br> &self,<br> segments: &[<a class="struct" href="../struct.SegmentMeta.html" title="struct tantivy::SegmentMeta">SegmentMeta</a>]<br>) -> Vec<<a class="struct" href="struct.MergeCandidate.html" title="struct tantivy::merge_policy::MergeCandidate">MergeCandidate</a>></h4></section></summary><div class="docblock"><p>Given the list of segment metas, returns the list of merge candidates.</p> |
| <p>This call happens on the segment updater thread, and will block |
| other segment updates, so all implementations should happen rapidly.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-MergePolicy-for-LogMergePolicy" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/indexer/log_merge_policy.rs.html#93-128">source</a><a href="#impl-MergePolicy-for-LogMergePolicy" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.MergePolicy.html" title="trait tantivy::merge_policy::MergePolicy">MergePolicy</a> for <a class="struct" href="struct.LogMergePolicy.html" title="struct tantivy::merge_policy::LogMergePolicy">LogMergePolicy</a></h3></section><section id="impl-MergePolicy-for-NoMergePolicy" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/indexer/merge_policy.rs.html#32-36">source</a><a href="#impl-MergePolicy-for-NoMergePolicy" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.MergePolicy.html" title="trait tantivy::merge_policy::MergePolicy">MergePolicy</a> for <a class="struct" href="struct.NoMergePolicy.html" title="struct tantivy::merge_policy::NoMergePolicy">NoMergePolicy</a></h3></section></div><script src="../../implementors/tantivy/indexer/merge_policy/trait.MergePolicy.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> |
