Struct MemoryIndex 

pub struct MemoryIndex { /* private fields */ }

An in-process fielded BM25 index.

Implementations

impl MemoryIndex

pub fn new() -> Self

An empty index.

pub fn build(documents: impl IntoIterator<Item = IndexedMemory>) -> Self

Build an index from a set of documents.

pub fn revision(&self) -> u64

The index revision, bumped on every mutation.

pub fn len(&self) -> usize

How many live documents the index holds.

pub fn is_empty(&self) -> bool

Whether the index holds no live documents.

pub fn upsert(&mut self, doc: IndexedMemory)

Insert or replace a document.

pub fn remove(&mut self, id: &MemoryId) -> bool

Remove a document. Removing a missing document is a no-op.

pub fn clear(&mut self)

Drop every document.

pub fn get(&self, id: &MemoryId) -> Option<&IndexedMemory>

Fetch an indexed document.

pub fn documents(&self) -> impl Iterator<Item = &IndexedMemory>

Every live document.

pub fn search(&self, query: &Query, now: DateTime<Utc>) -> Vec<SearchHit>

Run a query at time now.

Trait Implementations

impl Debug for MemoryIndex

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

Formats the value using the given formatter.

impl Default for MemoryIndex

fn default() -> MemoryIndex

Returns the “default value” for a type.