Struct tantivy::directory::RamDirectory

pub struct RamDirectory { /* fields omitted */ }

A Directory storing everything in anonymous memory.

It is mainly meant for unit testing. Writes are only made visible upon flushing.

Implementations

impl RamDirectory

pub fn create() -> RamDirectory

Constructor

pub fn total_mem_usage(&self) -> usize

Returns the sum of the size of the different files in the RamDirectory.

pub fn persist(&self, dest: &dyn Directory) -> Result<()>

Write a copy of all of the files saved in the RamDirectory in the target Directory.

Files are all written using the Directory::write meaning, even if they were written using the atomic_write api.

If an error is encounterred, files may be persisted partially.

Trait Implementations

impl Clone for RamDirectory

fn clone(&self) -> RamDirectory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RamDirectory

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

Formats the value using the given formatter.

impl Default for RamDirectory

fn default() -> RamDirectory

Returns the “default value” for a type.

impl Directory for RamDirectory

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

Opens a file and returns a boxed FileHandle.

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

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

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

Removes a file

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, data: &[u8]) -> Result<()>

Atomically replace the content of a file with data.

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 acquire_lock(&self, lock: &Lock) -> Result<DirectoryLock, LockError>

Acquire a lock in the given directory.