Struct tantivy::directory::ManagedDirectory

pub struct ManagedDirectory { /* fields omitted */ }

Wrapper of directories that keeps track of files created by Tantivy.

A managed directory is just a wrapper of a directory that keeps a (persisted) list of the files that have been created (and not deleted) by tantivy so far.

Thanks to this list, it implements a garbage_collect method that removes the files that were created by tantivy and are not useful anymore.

Methods

impl ManagedDirectory

pub fn wrap<Dir: Directory>(directory: Dir) -> Result<ManagedDirectory>

Wraps a directory as managed directory.

pub fn garbage_collect<L: FnOnce() -> HashSet<PathBuf>>(
    &mut self,
    get_living_files: L
)

Garbage collect unused files.

Removes the files that were created by tantivy and are not used by any segment anymore.

• living_files - List of files that are still used by the index.

The use a callback ensures that the list of living_files is computed while we hold the lock on meta.

This method does not panick nor returns errors. If a file cannot be deleted (for permission reasons for instance) an error is simply logged, and the file remains in the list of managed files.

Trait Implementations

impl Directory for ManagedDirectory

fn open_read(&self, path: &Path) -> Result<ReadOnlySource, OpenReadError>

Opens a virtual file for read.

fn open_write(&mut self, path: &Path) -> Result<WritePtr, OpenWriteError>

Opens a writer for the virtual file associated with a Path.

fn atomic_write(&mut self, path: &Path, data: &[u8]) -> Result<()>

Atomically replace the content of a file with data.

fn atomic_read(&self, path: &Path) -> Result<Vec<u8>, OpenReadError>

Reads the full content file that has been written using atomic_write.

fn delete(&self, path: &Path) -> Result<(), DeleteError>

Removes a file

fn exists(&self, path: &Path) -> bool

Returns true iff the file exists

fn acquire_lock(&self, lock: &Lock) -> Result<DirectoryLock, LockError>

Acquire a lock in the given directory.

fn watch(&self, watch_callback: WatchCallback) -> Result<WatchHandle>

Registers a callback that will be called whenever a change on the meta.json using the atomic_write API is detected.

impl Clone for ManagedDirectory

fn clone(&self) -> ManagedDirectory

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ManagedDirectory

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.