| <!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/directory/watch_event_router.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>watch_event_router.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::sync::{Arc, RwLock, Weak}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::FutureResult; |
| |
| <span class="doccomment">/// Cloneable wrapper for callbacks registered when watching files of a `Directory`. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>WatchCallback(Arc<<span class="kw">dyn </span>Fn() + Sync + Send>); |
| |
| <span class="kw">impl </span>WatchCallback { |
| <span class="doccomment">/// Wraps a `Fn()` to create a WatchCallback. |
| </span><span class="kw">pub fn </span>new<F: Fn() + Sync + Send + <span class="lifetime">'static</span>>(op: F) -> <span class="self">Self </span>{ |
| WatchCallback(Arc::new(op)) |
| } |
| |
| <span class="kw">fn </span>call(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="self">self</span>.<span class="number">0</span>() |
| } |
| } |
| |
| <span class="doccomment">/// Helper struct to implement the watch method in `Directory` implementations. |
| /// |
| /// It registers callbacks (See `.subscribe(...)`) and |
| /// calls them upon calls to `.broadcast(...)`. |
| </span><span class="attribute">#[derive(Default)] |
| </span><span class="kw">pub struct </span>WatchCallbackList { |
| router: RwLock<Vec<Weak<WatchCallback>>>, |
| } |
| |
| <span class="doccomment">/// Controls how long a directory should watch for a file change. |
| /// |
| /// After all the clones of `WatchHandle` are dropped, the associated will not be called when a |
| /// file change is detected. |
| </span><span class="attribute">#[must_use = <span class="string">"This `WatchHandle` controls the lifetime of the watch and should therefore be used."</span>] |
| #[derive(Clone)] |
| </span><span class="kw">pub struct </span>WatchHandle(Arc<WatchCallback>); |
| |
| <span class="kw">impl </span>WatchHandle { |
| <span class="doccomment">/// Create a WatchHandle handle. |
| </span><span class="kw">pub fn </span>new(watch_callback: Arc<WatchCallback>) -> WatchHandle { |
| WatchHandle(watch_callback) |
| } |
| |
| <span class="doccomment">/// Returns an empty watch handle. |
| /// |
| /// This function is only useful when implementing a readonly directory. |
| </span><span class="kw">pub fn </span>empty() -> WatchHandle { |
| WatchHandle::new(Arc::new(WatchCallback::new(|| {}))) |
| } |
| } |
| |
| <span class="kw">impl </span>WatchCallbackList { |
| <span class="doccomment">/// Subscribes a new callback and returns a handle that controls the lifetime of the callback. |
| </span><span class="kw">pub fn </span>subscribe(<span class="kw-2">&</span><span class="self">self</span>, watch_callback: WatchCallback) -> WatchHandle { |
| <span class="kw">let </span>watch_callback_arc = Arc::new(watch_callback); |
| <span class="kw">let </span>watch_callback_weak = Arc::downgrade(<span class="kw-2">&</span>watch_callback_arc); |
| <span class="self">self</span>.router.write().unwrap().push(watch_callback_weak); |
| WatchHandle::new(watch_callback_arc) |
| } |
| |
| <span class="kw">fn </span>list_callback(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<WatchCallback> { |
| <span class="kw">let </span><span class="kw-2">mut </span>callbacks: Vec<WatchCallback> = <span class="macro">vec!</span>[]; |
| <span class="kw">let </span><span class="kw-2">mut </span>router_wlock = <span class="self">self</span>.router.write().unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>; |
| <span class="kw">while </span>i < router_wlock.len() { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(watch) = router_wlock[i].upgrade() { |
| callbacks.push(watch.as_ref().clone()); |
| i += <span class="number">1</span>; |
| } <span class="kw">else </span>{ |
| router_wlock.swap_remove(i); |
| } |
| } |
| callbacks |
| } |
| |
| <span class="doccomment">/// Triggers all callbacks |
| </span><span class="kw">pub fn </span>broadcast(<span class="kw-2">&</span><span class="self">self</span>) -> FutureResult<()> { |
| <span class="kw">let </span>callbacks = <span class="self">self</span>.list_callback(); |
| <span class="kw">let </span>(result, sender) = FutureResult::create(<span class="string">"One of the callback panicked."</span>); |
| <span class="kw">if </span>callbacks.is_empty() { |
| <span class="kw">let _ </span>= sender.send(<span class="prelude-val">Ok</span>(())); |
| <span class="kw">return </span>result; |
| } |
| <span class="kw">let </span>spawn_res = std::thread::Builder::new() |
| .name(<span class="string">"watch-callbacks"</span>.to_string()) |
| .spawn(<span class="kw">move </span>|| { |
| <span class="kw">for </span>callback <span class="kw">in </span>callbacks { |
| callback.call(); |
| } |
| <span class="kw">let _ </span>= sender.send(<span class="prelude-val">Ok</span>(())); |
| }); |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(err) = spawn_res { |
| <span class="macro">error!</span>( |
| <span class="string">"Failed to spawn thread to call watch callbacks. Cause: {:?}"</span>, |
| err |
| ); |
| } |
| result |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::mem; |
| <span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering}; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::directory::{WatchCallback, WatchCallbackList}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_watch_event_router_simple() { |
| <span class="kw">let </span>watch_event_router = WatchCallbackList::default(); |
| <span class="kw">let </span>counter: Arc<AtomicUsize> = Default::default(); |
| <span class="kw">let </span>counter_clone = counter.clone(); |
| <span class="kw">let </span>inc_callback = WatchCallback::new(<span class="kw">move </span>|| { |
| counter_clone.fetch_add(<span class="number">1</span>, Ordering::SeqCst); |
| }); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, counter.load(Ordering::SeqCst)); |
| <span class="kw">let </span>handle_a = watch_event_router.subscribe(inc_callback); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, counter.load(Ordering::SeqCst)); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">1</span>, counter.load(Ordering::SeqCst)); |
| watch_event_router.broadcast().wait().unwrap(); |
| watch_event_router.broadcast().wait().unwrap(); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">4</span>, counter.load(Ordering::SeqCst)); |
| mem::drop(handle_a); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">4</span>, counter.load(Ordering::SeqCst)); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_watch_event_router_multiple_callback_same_key() { |
| <span class="kw">let </span>watch_event_router = WatchCallbackList::default(); |
| <span class="kw">let </span>counter: Arc<AtomicUsize> = Default::default(); |
| <span class="kw">let </span>inc_callback = |inc: usize| { |
| <span class="kw">let </span>counter_clone = counter.clone(); |
| WatchCallback::new(<span class="kw">move </span>|| { |
| counter_clone.fetch_add(inc, Ordering::SeqCst); |
| }) |
| }; |
| <span class="kw">let </span>handle_a = watch_event_router.subscribe(inc_callback(<span class="number">1</span>)); |
| <span class="kw">let </span>handle_a2 = watch_event_router.subscribe(inc_callback(<span class="number">10</span>)); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, counter.load(Ordering::SeqCst)); |
| watch_event_router.broadcast().wait().unwrap(); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">22</span>, counter.load(Ordering::SeqCst)); |
| mem::drop(handle_a); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">32</span>, counter.load(Ordering::SeqCst)); |
| mem::drop(handle_a2); |
| watch_event_router.broadcast().wait().unwrap(); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">32</span>, counter.load(Ordering::SeqCst)); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_watch_event_router_multiple_callback_different_key() { |
| <span class="kw">let </span>watch_event_router = WatchCallbackList::default(); |
| <span class="kw">let </span>counter: Arc<AtomicUsize> = Default::default(); |
| <span class="kw">let </span>counter_clone = counter.clone(); |
| <span class="kw">let </span>inc_callback = WatchCallback::new(<span class="kw">move </span>|| { |
| counter_clone.fetch_add(<span class="number">1</span>, Ordering::SeqCst); |
| }); |
| <span class="kw">let </span>handle_a = watch_event_router.subscribe(inc_callback); |
| <span class="macro">assert_eq!</span>(<span class="number">0</span>, counter.load(Ordering::SeqCst)); |
| watch_event_router.broadcast().wait().unwrap(); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, counter.load(Ordering::SeqCst)); |
| mem::drop(handle_a); |
| <span class="kw">let _ </span>= watch_event_router.broadcast(); |
| watch_event_router.broadcast().wait().unwrap(); |
| <span class="macro">assert_eq!</span>(<span class="number">2</span>, counter.load(Ordering::SeqCst)); |
| } |
| } |
| </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> |
