Struct IndexHandle 

pub struct IndexHandle { /* private fields */ }

Shared, swappable index state.

Held behind an RwLock rather than rebuilt per query: retrieval runs while the user is still speaking, so it must never wait on a rebuild.

Implementations

impl IndexHandle

pub fn new() -> Self

An empty handle.

pub fn with_index(index: MemoryIndex) -> Self

Wrap an existing index.

pub fn replace(&self, index: MemoryIndex)

Replace the index wholesale, e.g. after a corpus recompile.

pub fn read(&self) -> RwLockReadGuard<'_, MemoryIndex>

Read the index.

pub fn write(&self) -> RwLockWriteGuard<'_, MemoryIndex>

Mutate the index in place.

pub fn revision(&self) -> u64

A revision that advances on every replacement and every mutation.

Trait Implementations

impl Debug for IndexHandle

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

Formats the value using the given formatter.

impl Default for IndexHandle

fn default() -> IndexHandle

Returns the “default value” for a type.