| <!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/directory_lock.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>directory_lock.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::path::PathBuf; |
| |
| <span class="kw">use </span>once_cell::sync::Lazy; |
| |
| <span class="doccomment">/// A directory lock. |
| /// |
| /// A lock is associated with a specific path. |
| /// |
| /// The lock will be passed to [`Directory::acquire_lock`](crate::Directory::acquire_lock). |
| /// |
| /// Tantivy itself uses only two locks but client application |
| /// can use the directory facility to define their own locks. |
| /// - [`INDEX_WRITER_LOCK`] |
| /// - [`META_LOCK`] |
| /// |
| /// Check out these locks documentation for more information. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Lock { |
| <span class="doccomment">/// The lock needs to be associated with its own file `path`. |
| /// Depending on the platform, the lock might rely on the creation |
| /// and deletion of this filepath. |
| </span><span class="kw">pub </span>filepath: PathBuf, |
| <span class="doccomment">/// `is_blocking` describes whether acquiring the lock is meant |
| /// to be a blocking operation or a non-blocking. |
| /// |
| /// Acquiring a blocking lock blocks until the lock is |
| /// available. |
| /// |
| /// Acquiring a non-blocking lock returns rapidly, either successfully |
| /// or with an error signifying that someone is already holding |
| /// the lock. |
| </span><span class="kw">pub </span>is_blocking: bool, |
| } |
| |
| <span class="doccomment">/// Only one process should be able to write tantivy's index at a time. |
| /// This lock file, when present, is in charge of preventing other processes to open an |
| /// `IndexWriter`. |
| /// |
| /// If the process is killed and this file remains, it is safe to remove it manually. |
| /// |
| /// Failing to acquire this lock usually means a misuse of tantivy's API, |
| /// (creating more than one instance of the `IndexWriter`), are a spurious |
| /// lock file remaining after a crash. In the latter case, removing the file after |
| /// checking no process running tantivy is running is safe. |
| </span><span class="kw">pub static </span>INDEX_WRITER_LOCK: Lazy<Lock> = Lazy::new(|| Lock { |
| filepath: PathBuf::from(<span class="string">".tantivy-writer.lock"</span>), |
| is_blocking: <span class="bool-val">false</span>, |
| }); |
| <span class="doccomment">/// The meta lock file is here to protect the segment files being opened by |
| /// `IndexReader::reload()` from being garbage collected. |
| /// It makes it possible for another process to safely consume |
| /// our index in-writing. Ideally, we may have preferred `RWLock` semantics |
| /// here, but it is difficult to achieve on Windows. |
| /// |
| /// Opening segment readers is a very fast process. |
| </span><span class="kw">pub static </span>META_LOCK: Lazy<Lock> = Lazy::new(|| Lock { |
| filepath: PathBuf::from(<span class="string">".tantivy-meta.lock"</span>), |
| is_blocking: <span class="bool-val">true</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> |
