| <!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/core/executor.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>executor.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>rayon::{ThreadPool, ThreadPoolBuilder}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::TantivyError; |
| |
| <span class="doccomment">/// Search executor whether search request are single thread or multithread. |
| /// |
| /// We don't expose Rayon thread pool directly here for several reasons. |
| /// |
| /// First dependency hell. It is not a good idea to expose the |
| /// API of a dependency, knowing it might conflict with a different version |
| /// used by the client. Second, we may stop using rayon in the future. |
| </span><span class="kw">pub enum </span>Executor { |
| <span class="doccomment">/// Single thread variant of an Executor |
| </span>SingleThread, |
| <span class="doccomment">/// Thread pool variant of an Executor |
| </span>ThreadPool(ThreadPool), |
| } |
| |
| <span class="kw">impl </span>Executor { |
| <span class="doccomment">/// Creates an Executor that performs all task in the caller thread. |
| </span><span class="kw">pub fn </span>single_thread() -> Executor { |
| Executor::SingleThread |
| } |
| |
| <span class="doccomment">/// Creates an Executor that dispatches the tasks in a thread pool. |
| </span><span class="kw">pub fn </span>multi_thread(num_threads: usize, prefix: <span class="kw-2">&</span><span class="lifetime">'static </span>str) -> <span class="kw">crate</span>::Result<Executor> { |
| <span class="kw">let </span>pool = ThreadPoolBuilder::new() |
| .num_threads(num_threads) |
| .thread_name(<span class="kw">move </span>|num| <span class="macro">format!</span>(<span class="string">"{}{}"</span>, prefix, num)) |
| .build()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(Executor::ThreadPool(pool)) |
| } |
| |
| <span class="doccomment">/// Perform a map in the thread pool. |
| /// |
| /// Regardless of the executor (`SingleThread` or `ThreadPool`), panics in the task |
| /// will propagate to the caller. |
| </span><span class="kw">pub fn </span>map< |
| A: Send, |
| R: Send, |
| AIterator: Iterator<Item = A>, |
| F: Sized + Sync + Fn(A) -> <span class="kw">crate</span>::Result<R>, |
| >( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| f: F, |
| args: AIterator, |
| ) -> <span class="kw">crate</span>::Result<Vec<R>> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| Executor::SingleThread => args.map(f).collect::<<span class="kw">crate</span>::Result<<span class="kw">_</span>>>(), |
| Executor::ThreadPool(pool) => { |
| <span class="kw">let </span>args: Vec<A> = args.collect(); |
| <span class="kw">let </span>num_fruits = args.len(); |
| <span class="kw">let </span>fruit_receiver = { |
| <span class="kw">let </span>(fruit_sender, fruit_receiver) = crossbeam_channel::unbounded(); |
| pool.scope(|scope| { |
| <span class="kw">for </span>(idx, arg) <span class="kw">in </span>args.into_iter().enumerate() { |
| <span class="comment">// We name references for f and fruit_sender_ref because we do not |
| // want these two to be moved into the closure. |
| </span><span class="kw">let </span>f_ref = <span class="kw-2">&</span>f; |
| <span class="kw">let </span>fruit_sender_ref = <span class="kw-2">&</span>fruit_sender; |
| scope.spawn(<span class="kw">move </span>|<span class="kw">_</span>| { |
| <span class="kw">let </span>fruit = f_ref(arg); |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(err) = fruit_sender_ref.send((idx, fruit)) { |
| <span class="macro">error!</span>( |
| <span class="string">"Failed to send search task. It probably means all search \ |
| threads have panicked. {:?}"</span>, |
| err |
| ); |
| } |
| }); |
| } |
| }); |
| fruit_receiver |
| <span class="comment">// This ends the scope of fruit_sender. |
| // This is important as it makes it possible for the fruit_receiver iteration to |
| // terminate. |
| </span>}; |
| <span class="kw">let </span><span class="kw-2">mut </span>result_placeholders: Vec<<span class="prelude-ty">Option</span><R>> = |
| std::iter::repeat_with(|| <span class="prelude-val">None</span>).take(num_fruits).collect(); |
| <span class="kw">for </span>(pos, fruit_res) <span class="kw">in </span>fruit_receiver { |
| <span class="kw">let </span>fruit = fruit_res<span class="question-mark">?</span>; |
| result_placeholders[pos] = <span class="prelude-val">Some</span>(fruit); |
| } |
| <span class="kw">let </span>results: Vec<R> = result_placeholders.into_iter().flatten().collect(); |
| <span class="kw">if </span>results.len() != num_fruits { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(TantivyError::InternalError( |
| <span class="string">"One of the mapped execution failed."</span>.to_string(), |
| )); |
| } |
| <span class="prelude-val">Ok</span>(results) |
| } |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| |
| <span class="kw">use </span><span class="kw">super</span>::Executor; |
| |
| <span class="attribute">#[test] |
| #[should_panic(expected = <span class="string">"panic should propagate"</span>)] |
| </span><span class="kw">fn </span>test_panic_propagates_single_thread() { |
| <span class="kw">let </span>_result: Vec<usize> = Executor::single_thread() |
| .map( |
| |<span class="kw">_</span>| { |
| <span class="macro">panic!</span>(<span class="string">"panic should propagate"</span>); |
| }, |
| <span class="macro">vec!</span>[<span class="number">0</span>].into_iter(), |
| ) |
| .unwrap(); |
| } |
| |
| <span class="attribute">#[test] |
| #[should_panic] </span><span class="comment">//< unfortunately the panic message is not propagated |
| </span><span class="kw">fn </span>test_panic_propagates_multi_thread() { |
| <span class="kw">let </span>_result: Vec<usize> = Executor::multi_thread(<span class="number">1</span>, <span class="string">"search-test"</span>) |
| .unwrap() |
| .map( |
| |<span class="kw">_</span>| { |
| <span class="macro">panic!</span>(<span class="string">"panic should propagate"</span>); |
| }, |
| <span class="macro">vec!</span>[<span class="number">0</span>].into_iter(), |
| ) |
| .unwrap(); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_map_singlethread() { |
| <span class="kw">let </span>result: Vec<usize> = Executor::single_thread() |
| .map(|i| <span class="prelude-val">Ok</span>(i * <span class="number">2</span>), <span class="number">0</span>..<span class="number">1_000</span>) |
| .unwrap(); |
| <span class="macro">assert_eq!</span>(result.len(), <span class="number">1_000</span>); |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">1_000 </span>{ |
| <span class="macro">assert_eq!</span>(result[i], i * <span class="number">2</span>); |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_map_multithread() { |
| <span class="kw">let </span>result: Vec<usize> = Executor::multi_thread(<span class="number">3</span>, <span class="string">"search-test"</span>) |
| .unwrap() |
| .map(|i| <span class="prelude-val">Ok</span>(i * <span class="number">2</span>), <span class="number">0</span>..<span class="number">10</span>) |
| .unwrap(); |
| <span class="macro">assert_eq!</span>(result.len(), <span class="number">10</span>); |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| <span class="macro">assert_eq!</span>(result[i], i * <span class="number">2</span>); |
| } |
| } |
| } |
| </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> |
