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.

Methods

impl MmapDirectory

pub fn create_from_tempdir() -> Result<MmapDirectory>

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(&mut 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 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 delete(&self, path: &Path) -> Result<(), DeleteError>

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

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

Returns true iff the file exists

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

Atomically replace the content of a file with data.

Important traits for Box<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn box_clone(&self) -> Box<Directory>

Clones the directory and boxes the clone