Struct HotDirectory 

pub struct HotDirectory { /* private fields */ }

The hot directory accelerates a given directory, by placing a static cache in front of a directory.

The HotDirectory does not implement write operations. It has been designed for quickwit in order to regroup all of the small random read operations required to open an index. All of these operations are gather into a single file called the hotcache.

Implementations

impl HotDirectory

pub fn open( underlying: Box<dyn Directory>, static_cache: StaticDirectoryCache, ) -> Result<HotDirectory>

Wraps an index, with a static cache serialized into hot_cache_bytes.

Trait Implementations

impl Clone for HotDirectory

fn clone(&self) -> HotDirectory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HotDirectory

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

Formats the value using the given formatter.

impl Directory for HotDirectory

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

Opens a file and returns a boxed FileHandle.

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

Returns true if and only if the file exists

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

Reads the full content file that has been written using Directory::atomic_write().

fn atomic_read_async<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, OpenReadError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Reads asynchronously the full content file that has been written using Directory::atomic_write().

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

Acquire a lock in the directory given in the Lock.

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

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

fn as_any(&self) -> &dyn Any

fn underlying_directory(&self) -> Option<&dyn Directory>

fn real_directory(&self) -> &dyn Directory

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

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

fn open_read_async<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<FileSlice, OpenReadError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

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

Removes a file

fn delete_async<'life0, 'life1, 'async_trait>( &'life0 self, _: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<(), DeleteError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn open_write( &self, _: &Path, ) -> Result<BufWriter<Box<dyn TerminatingWrite>>, OpenWriteError>

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

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

Atomically replace the content of a file with data.

fn sync_directory(&self) -> Result<(), Error>

Sync the directory.