Module tantivy::directory[][src]

Expand description

WORM directory abstraction.

Modules

Errors specific to the directory module.

Structs

Struct used to prevent from calling terminate_ref directly

The DirectoryLock is an object that represents a file lock. See LockType

Logical slice of read only file in tantivy.

Outcome of the Garbage collection

A directory lock.

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

Directory storing data in files, read via mmap.

An OwnedBytes simply wraps an object that owns a slice of data and exposes this data as a static slice.

A Directory storing everything in anonymous memory.

Cloneable wrapper for callbacks registered when watching files of a Directory.

Helper struct to implement the watch method in Directory implementations.

Controls how long a directory should watch for a file change.

Statics

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.

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 prefered RWLock semantics here, but it is difficult to achieve on Windows.

Traits

Write-once read many (WORM) abstraction for where tantivy’s data should be stored.

DirectoryClone

Objects that represents files sections in tantivy.

Trait used to indicate when no more write need to be done on a writer

Type Definitions

Write object for Directory.