| <!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/indexer/stamper.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>stamper.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::ops::Range; |
| <span class="kw">use </span>std::sync::atomic::Ordering; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::Opstamp; |
| |
| <span class="attribute">#[cfg(not(target_arch = <span class="string">"arm"</span>))] |
| </span><span class="kw">mod </span>atomic_impl { |
| |
| <span class="kw">use </span>std::sync::atomic::{AtomicU64, Ordering}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::Opstamp; |
| |
| <span class="attribute">#[derive(Default)] |
| </span><span class="kw">pub struct </span>AtomicU64Wrapper(AtomicU64); |
| |
| <span class="kw">impl </span>AtomicU64Wrapper { |
| <span class="kw">pub fn </span>new(first_opstamp: Opstamp) -> AtomicU64Wrapper { |
| AtomicU64Wrapper(AtomicU64::new(first_opstamp <span class="kw">as </span>u64)) |
| } |
| |
| <span class="kw">pub fn </span>fetch_add(<span class="kw-2">&</span><span class="self">self</span>, val: u64, order: Ordering) -> u64 { |
| <span class="self">self</span>.<span class="number">0</span>.fetch_add(val <span class="kw">as </span>u64, order) <span class="kw">as </span>u64 |
| } |
| |
| <span class="kw">pub fn </span>revert(<span class="kw-2">&</span><span class="self">self</span>, val: u64, order: Ordering) -> u64 { |
| <span class="self">self</span>.<span class="number">0</span>.store(val, order); |
| val |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(target_arch = <span class="string">"arm"</span>)] |
| </span><span class="kw">mod </span>atomic_impl { |
| |
| <span class="doccomment">/// Under other architecture, we rely on a mutex. |
| </span><span class="kw">use </span>std::sync::atomic::Ordering; |
| <span class="kw">use </span>std::sync::RwLock; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::Opstamp; |
| |
| <span class="attribute">#[derive(Default)] |
| </span><span class="kw">pub struct </span>AtomicU64Wrapper(RwLock<u64>); |
| |
| <span class="kw">impl </span>AtomicU64Wrapper { |
| <span class="kw">pub fn </span>new(first_opstamp: Opstamp) -> AtomicU64Wrapper { |
| AtomicU64Wrapper(RwLock::new(first_opstamp)) |
| } |
| |
| <span class="kw">pub fn </span>fetch_add(<span class="kw-2">&</span><span class="self">self</span>, incr: u64, _order: Ordering) -> u64 { |
| <span class="kw">let </span><span class="kw-2">mut </span>lock = <span class="self">self</span>.<span class="number">0</span>.write().unwrap(); |
| <span class="kw">let </span>previous_val = <span class="kw-2">*</span>lock; |
| <span class="kw-2">*</span>lock = previous_val + incr; |
| previous_val |
| } |
| |
| <span class="kw">pub fn </span>revert(<span class="kw-2">&</span><span class="self">self</span>, val: u64, _order: Ordering) -> u64 { |
| <span class="kw">let </span><span class="kw-2">mut </span>lock = <span class="self">self</span>.<span class="number">0</span>.write().unwrap(); |
| <span class="kw-2">*</span>lock = val; |
| val |
| } |
| } |
| } |
| |
| <span class="kw">use </span><span class="self">self</span>::atomic_impl::AtomicU64Wrapper; |
| |
| <span class="doccomment">/// Stamper provides Opstamps, which is just an auto-increment id to label |
| /// an operation. |
| /// |
| /// Cloning does not "fork" the stamp generation. The stamper actually wraps an `Arc`. |
| </span><span class="attribute">#[derive(Clone, Default)] |
| </span><span class="kw">pub struct </span>Stamper(Arc<AtomicU64Wrapper>); |
| |
| <span class="kw">impl </span>Stamper { |
| <span class="kw">pub fn </span>new(first_opstamp: Opstamp) -> Stamper { |
| Stamper(Arc::new(AtomicU64Wrapper::new(first_opstamp))) |
| } |
| |
| <span class="kw">pub fn </span>stamp(<span class="kw-2">&</span><span class="self">self</span>) -> Opstamp { |
| <span class="self">self</span>.<span class="number">0</span>.fetch_add(<span class="number">1u64</span>, Ordering::SeqCst) <span class="kw">as </span>u64 |
| } |
| |
| <span class="doccomment">/// Given a desired count `n`, `stamps` returns an iterator that |
| /// will supply `n` number of u64 stamps. |
| </span><span class="kw">pub fn </span>stamps(<span class="kw-2">&</span><span class="self">self</span>, n: u64) -> Range<Opstamp> { |
| <span class="kw">let </span>start = <span class="self">self</span>.<span class="number">0</span>.fetch_add(n, Ordering::SeqCst); |
| Range { |
| start, |
| end: start + n, |
| } |
| } |
| |
| <span class="doccomment">/// Reverts the stamper to a given `Opstamp` value and returns it |
| </span><span class="kw">pub fn </span>revert(<span class="kw-2">&</span><span class="self">self</span>, to_opstamp: Opstamp) -> Opstamp { |
| <span class="self">self</span>.<span class="number">0</span>.revert(to_opstamp, Ordering::SeqCst) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| |
| <span class="kw">use </span><span class="kw">super</span>::Stamper; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_stamper() { |
| <span class="kw">let </span>stamper = Stamper::new(<span class="number">7u64</span>); |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">7u64</span>); |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">8u64</span>); |
| |
| <span class="kw">let </span>stamper_clone = stamper.clone(); |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">9u64</span>); |
| |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">10u64</span>); |
| <span class="macro">assert_eq!</span>(stamper_clone.stamp(), <span class="number">11u64</span>); |
| <span class="macro">assert_eq!</span>(stamper.stamps(<span class="number">3u64</span>), (<span class="number">12</span>..<span class="number">15</span>)); |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">15u64</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_stamper_revert() { |
| <span class="kw">let </span>stamper = Stamper::new(<span class="number">7u64</span>); |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">7u64</span>); |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">8u64</span>); |
| |
| <span class="kw">let </span>stamper_clone = stamper.clone(); |
| <span class="macro">assert_eq!</span>(stamper_clone.stamp(), <span class="number">9u64</span>); |
| |
| stamper.revert(<span class="number">6</span>); |
| <span class="macro">assert_eq!</span>(stamper.stamp(), <span class="number">6</span>); |
| <span class="macro">assert_eq!</span>(stamper_clone.stamp(), <span class="number">7</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> |
