| <!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="Write-once read many (WORM) abstraction for where tantivy’s data should be stored."><meta name="keywords" content="rust, rustlang, rust-lang, Directory"><title>Directory in tantivy - 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="#">Directory</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.atomic_read">atomic_read</a></li><li><a href="#tymethod.atomic_write">atomic_write</a></li><li><a href="#tymethod.delete">delete</a></li><li><a href="#tymethod.exists">exists</a></li><li><a href="#tymethod.get_file_handle">get_file_handle</a></li><li><a href="#tymethod.open_write">open_write</a></li><li><a href="#tymethod.sync_directory">sync_directory</a></li><li><a href="#tymethod.watch">watch</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.acquire_lock">acquire_lock</a></li><li><a href="#method.open_read">open_read</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Box%3Cdyn%20Directory%3E">Clone</a></li><li><a href="#impl-From%3CT%3E-for-Box%3Cdyn%20Directory%3E">From<T></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy</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 class="trait" href="#">Directory</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/directory/directory.rs.html#109-228">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 Directory: <a class="trait" href="directory/trait.DirectoryClone.html" title="trait tantivy::directory::DirectoryClone">DirectoryClone</a> + Debug + Send + Sync + 'static { |
| fn <a href="#tymethod.get_file_handle" class="fnname">get_file_handle</a>(<br> &self,<br> path: &Path<br> ) -> Result<Arc<dyn <a class="trait" href="directory/trait.FileHandle.html" title="trait tantivy::directory::FileHandle">FileHandle</a>>, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.delete" class="fnname">delete</a>(&self, path: &Path) -> Result<(), <a class="enum" href="directory/error/enum.DeleteError.html" title="enum tantivy::directory::error::DeleteError">DeleteError</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.exists" class="fnname">exists</a>(&self, path: &Path) -> Result<bool, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.open_write" class="fnname">open_write</a>(&self, path: &Path) -> Result<<a class="type" href="directory/type.WritePtr.html" title="type tantivy::directory::WritePtr">WritePtr</a>, <a class="enum" href="directory/error/enum.OpenWriteError.html" title="enum tantivy::directory::error::OpenWriteError">OpenWriteError</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.atomic_read" class="fnname">atomic_read</a>(&self, path: &Path) -> Result<Vec<u8>, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.atomic_write" class="fnname">atomic_write</a>(&self, path: &Path, data: &[u8]) -> Result<()>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.sync_directory" class="fnname">sync_directory</a>(&self) -> Result<()>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.watch" class="fnname">watch</a>(&self, watch_callback: <a class="struct" href="directory/struct.WatchCallback.html" title="struct tantivy::directory::WatchCallback">WatchCallback</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="directory/struct.WatchHandle.html" title="struct tantivy::directory::WatchHandle">WatchHandle</a>>; |
| |
| fn <a href="#method.open_read" class="fnname">open_read</a>(&self, path: &Path) -> Result<<a class="struct" href="directory/struct.FileSlice.html" title="struct tantivy::directory::FileSlice">FileSlice</a>, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.acquire_lock" class="fnname">acquire_lock</a>(&self, lock: &<a class="struct" href="directory/struct.Lock.html" title="struct tantivy::directory::Lock">Lock</a>) -> Result<<a class="struct" href="directory/struct.DirectoryLock.html" title="struct tantivy::directory::DirectoryLock">DirectoryLock</a>, <a class="enum" href="directory/error/enum.LockError.html" title="enum tantivy::directory::error::LockError">LockError</a>> { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Write-once read many (WORM) abstraction for where |
| tantivy’s data should be stored.</p> |
| <p>There are currently two implementations of <code>Directory</code></p> |
| <ul> |
| <li>The [<code>MMapDirectory</code>][crate::directory::MmapDirectory], this |
| should be your default choice.</li> |
| <li>The <a href="directory/struct.RamDirectory.html" title="crate::directory::RamDirectory"><code>RamDirectory</code></a>, which |
| should be used mostly for tests.</li> |
| </ul> |
| </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.get_file_handle" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#114">source</a><h4 class="code-header">fn <a href="#tymethod.get_file_handle" class="fnname">get_file_handle</a>(<br> &self,<br> path: &Path<br>) -> Result<Arc<dyn <a class="trait" href="directory/trait.FileHandle.html" title="trait tantivy::directory::FileHandle">FileHandle</a>>, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>></h4></section></summary><div class="docblock"><p>Opens a file and returns a boxed <code>FileHandle</code>.</p> |
| <p>Users of <code>Directory</code> should typically call <code>Directory::open_read(...)</code>, |
| while <code>Directory</code> implementor should implement <code>get_file_handle()</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.delete" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#135">source</a><h4 class="code-header">fn <a href="#tymethod.delete" class="fnname">delete</a>(&self, path: &Path) -> Result<(), <a class="enum" href="directory/error/enum.DeleteError.html" title="enum tantivy::directory::error::DeleteError">DeleteError</a>></h4></section></summary><div class="docblock"><p>Removes a file</p> |
| <p>Removing a file will not affect an eventual |
| existing <a href="directory/struct.FileSlice.html" title="FileSlice"><code>FileSlice</code></a> pointing to it.</p> |
| <p>Removing a nonexistent file, returns a |
| <a href="directory/error/enum.DeleteError.html#variant.FileDoesNotExist" title="DeleteError::FileDoesNotExist"><code>DeleteError::FileDoesNotExist</code></a>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.exists" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#138">source</a><h4 class="code-header">fn <a href="#tymethod.exists" class="fnname">exists</a>(&self, path: &Path) -> Result<bool, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>></h4></section></summary><div class="docblock"><p>Returns true if and only if the file exists</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.open_write" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#166">source</a><h4 class="code-header">fn <a href="#tymethod.open_write" class="fnname">open_write</a>(&self, path: &Path) -> Result<<a class="type" href="directory/type.WritePtr.html" title="type tantivy::directory::WritePtr">WritePtr</a>, <a class="enum" href="directory/error/enum.OpenWriteError.html" title="enum tantivy::directory::error::OpenWriteError">OpenWriteError</a>></h4></section></summary><div class="docblock"><p>Opens a writer for the <em>virtual file</em> associated with |
| a [<code>Path</code>].</p> |
| <p>Right after this call, for the span of the execution of the program |
| the file should be created and any subsequent call to |
| <a href="directory/trait.Directory.html#method.open_read" title="Directory::open_read()"><code>Directory::open_read()</code></a> for the same path should return |
| a <a href="directory/struct.FileSlice.html" title="FileSlice"><code>FileSlice</code></a>.</p> |
| <p>However, depending on the directory implementation, |
| it might be required to call <a href="directory/trait.Directory.html#tymethod.sync_directory" title="Directory::sync_directory()"><code>Directory::sync_directory()</code></a> to ensure |
| that the file is durably created. |
| (The semantics here are the same when dealing with |
| a POSIX filesystem.)</p> |
| <p>Write operations may be aggressively buffered. |
| The client of this trait is responsible for calling flush |
| to ensure that subsequent <code>read</code> operations |
| will take into account preceding <code>write</code> operations.</p> |
| <p>Flush operation should also be persistent.</p> |
| <p>The user shall not rely on [<code>Drop</code>] triggering <code>flush</code>. |
| Note that <a href="directory/struct.RamDirectory.html" title="crate::directory::RamDirectory"><code>RamDirectory</code></a> will |
| panic! if <code>flush</code> was not called.</p> |
| <p>The file may not previously exist.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.atomic_read" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#174">source</a><h4 class="code-header">fn <a href="#tymethod.atomic_read" class="fnname">atomic_read</a>(&self, path: &Path) -> Result<Vec<u8>, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>></h4></section></summary><div class="docblock"><p>Reads the full content file that has been written using |
| <a href="directory/trait.Directory.html#tymethod.atomic_write" title="Directory::atomic_write()"><code>Directory::atomic_write()</code></a>.</p> |
| <p>This should only be used for small files.</p> |
| <p>You should only use this to read files create with <a href="directory/trait.Directory.html#tymethod.atomic_write" title="Directory::atomic_write()"><code>Directory::atomic_write()</code></a>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.atomic_write" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#182">source</a><h4 class="code-header">fn <a href="#tymethod.atomic_write" class="fnname">atomic_write</a>(&self, path: &Path, data: &[u8]) -> Result<()></h4></section></summary><div class="docblock"><p>Atomically replace the content of a file with data.</p> |
| <p>This calls ensure that reads can never <em>observe</em> |
| a partially written file.</p> |
| <p>The file may or may not previously exist.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.sync_directory" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#188">source</a><h4 class="code-header">fn <a href="#tymethod.sync_directory" class="fnname">sync_directory</a>(&self) -> Result<()></h4></section></summary><div class="docblock"><p>Sync the directory.</p> |
| <p>This call is required to ensure that newly created files are |
| effectively stored durably.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.watch" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#227">source</a><h4 class="code-header">fn <a href="#tymethod.watch" class="fnname">watch</a>(&self, watch_callback: <a class="struct" href="directory/struct.WatchCallback.html" title="struct tantivy::directory::WatchCallback">WatchCallback</a>) -> <a class="type" href="type.Result.html" title="type tantivy::Result">Result</a><<a class="struct" href="directory/struct.WatchHandle.html" title="struct tantivy::directory::WatchHandle">WatchHandle</a>></h4></section></summary><div class="docblock"><p>Registers a callback that will be called whenever a change on the <code>meta.json</code> |
| using the <a href="directory/trait.Directory.html#tymethod.atomic_write" title="Directory::atomic_write()"><code>Directory::atomic_write()</code></a> API is detected.</p> |
| <p>The behavior when using <code>.watch()</code> on a file using <a href="directory/trait.Directory.html#tymethod.open_write" title="Directory::open_write()"><code>Directory::open_write()</code></a> is, on the |
| other hand, undefined.</p> |
| <p>The file will be watched for the lifetime of the returned <code>WatchHandle</code>. The caller is |
| required to keep it. |
| It does not override previous callbacks. When the file is modified, all callback that are |
| registered (and whose <a href="directory/struct.WatchHandle.html" title="WatchHandle"><code>WatchHandle</code></a> is still alive) are triggered.</p> |
| <p>Internally, tantivy only uses this API to detect new commits to implement the |
| <code>OnCommit</code> <code>ReloadPolicy</code>. Not implementing watch in a <code>Directory</code> only prevents the |
| <code>OnCommit</code> <code>ReloadPolicy</code> to work properly.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.open_read" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#123-126">source</a><h4 class="code-header">fn <a href="#method.open_read" class="fnname">open_read</a>(&self, path: &Path) -> Result<<a class="struct" href="directory/struct.FileSlice.html" title="struct tantivy::directory::FileSlice">FileSlice</a>, <a class="enum" href="directory/error/enum.OpenReadError.html" title="enum tantivy::directory::error::OpenReadError">OpenReadError</a>></h4></section></summary><div class="docblock"><p>Once a virtual file is open, its data may not |
| change.</p> |
| <p>Specifically, subsequent writes or flushes should |
| have no effect on the returned <a href="directory/struct.FileSlice.html" title="FileSlice"><code>FileSlice</code></a> object.</p> |
| <p>You should only use this to read files create with <a href="directory/trait.Directory.html#tymethod.open_write" title="Directory::open_write()"><code>Directory::open_write()</code></a>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.acquire_lock" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#193-211">source</a><h4 class="code-header">fn <a href="#method.acquire_lock" class="fnname">acquire_lock</a>(&self, lock: &<a class="struct" href="directory/struct.Lock.html" title="struct tantivy::directory::Lock">Lock</a>) -> Result<<a class="struct" href="directory/struct.DirectoryLock.html" title="struct tantivy::directory::DirectoryLock">DirectoryLock</a>, <a class="enum" href="directory/error/enum.LockError.html" title="enum tantivy::directory::error::LockError">LockError</a>></h4></section></summary><div class="docblock"><p>Acquire a lock in the directory given in the <a href="directory/struct.Lock.html" title="Lock"><code>Lock</code></a>.</p> |
| <p>The method is blocking or not depending on the <a href="directory/struct.Lock.html" title="Lock"><code>Lock</code></a> object.</p> |
| </div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Box%3Cdyn%20Directory%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#244-248">source</a><a href="#impl-Clone-for-Box%3Cdyn%20Directory%3E" class="anchor"></a><h3 class="code-header">impl Clone for Box<dyn <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#245-247">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CT%3E-for-Box%3Cdyn%20Directory%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#250-254">source</a><a href="#impl-From%3CT%3E-for-Box%3Cdyn%20Directory%3E" class="anchor"></a><h3 class="code-header">impl<T: <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a> + 'static> From<T> for Box<dyn <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/directory.rs.html#251-253">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></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-Directory-for-ManagedDirectory" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/managed_directory.rs.html#271-326">source</a><a href="#impl-Directory-for-ManagedDirectory" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a> for <a class="struct" href="directory/struct.ManagedDirectory.html" title="struct tantivy::directory::ManagedDirectory">ManagedDirectory</a></h3></section><section id="impl-Directory-for-RamDirectory" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/directory/ram_directory.rs.html#176-247">source</a><a href="#impl-Directory-for-RamDirectory" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="directory/trait.Directory.html" title="trait tantivy::directory::Directory">Directory</a> for <a class="struct" href="directory/struct.RamDirectory.html" title="struct tantivy::directory::RamDirectory">RamDirectory</a></h3></section></div><script src="../implementors/tantivy/directory/directory/trait.Directory.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> |
