Struct DebugProxyDirectory 

pub struct DebugProxyDirectory { /* private fields */ }

The debug proxy wraps another directory and simply acts as a proxy recording all of its read operations.

It has two purpose

• It is used when building our hotcache, to identify the file sections that should be in the hotcache.
• It is used in the search-api to provide debugging/performance information.

Implementations

impl DebugProxyDirectory

pub fn wrap(directory: Box<dyn Directory>) -> Self

Wraps another directory to log all of its read operations.

pub fn drain_read_operations(&self) -> impl Iterator<Item = ReadOperation> + '_

Returns all of the existing read operations.

Calling this “drains” the existing queue of operations.

Trait Implementations

impl Clone for DebugProxyDirectory

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebugProxyDirectory

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

Formats the value using the given formatter.

impl Directory for DebugProxyDirectory

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 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.

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

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