Struct tantivy::directory::MmapDirectory

pub struct MmapDirectory { /* fields omitted */ }

Directory storing data in files, read via mmap.

The Mmap object are cached to limit the system calls.

In the MmapDirectory, locks are implemented using the fs2 crate definition of locks.

On MacOS & linux, it relies on flock (aka BSD Lock). These locks solve most of the problems related to POSIX Locks, but may their contract may not be respected on NFS depending on the implementation.

On Windows the semantics are again different.

Implementations

impl MmapDirectory

pub fn create_from_tempdir() -> Result<MmapDirectory, OpenDirectoryError>

Creates a new MmapDirectory in a temporary directory.

This is mostly useful to test the MmapDirectory itself. For your unit tests, prefer the RamDirectory.

pub fn open<P: AsRef<Path>>(
    directory_path: P
) -> Result<MmapDirectory, OpenDirectoryError>

Opens a MmapDirectory in a directory.

Returns an error if the directory_path does not exist or if it is not a directory.

pub fn get_cache_info(&self) -> CacheInfo

Returns some statistical information about the Mmap cache.

The MmapDirectory embeds a MmapDirectory to avoid multiplying the mmap system calls.

Trait Implementations

impl Clone for MmapDirectory

fn clone(&self) -> MmapDirectory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MmapDirectory

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

Formats the value using the given formatter.

impl Directory for MmapDirectory

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

Any entry associated to the path in the mmap will be removed before the file is deleted.

fn get_file_handle(
    &self,
    path: &Path
) -> Result<Box<dyn FileHandle>, OpenReadError>

Opens a file and returns a boxed FileHandle.

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

Returns true iff the file exists

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

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

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

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

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

Atomically replace the content of a file with data.

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.

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

Once a virtual file is open, its data may not change.