TextIndex

Struct TextIndex 

Source
pub struct TextIndex { /* private fields */ }
Expand description

Text index for keyword search with pluggable tokenization and phrase support

Implementations§

Source§

impl TextIndex

Source

pub fn new() -> Self

Create a new TextIndex with the default SimpleTokenizer

Source

pub fn with_tokenizer(tokenizer: Box<dyn Tokenizer>) -> Self

Create a new TextIndex with a custom tokenizer

Source

pub fn tokenizer_name(&self) -> &'static str

Get the name of the current tokenizer

Source

pub fn index_document(&mut self, id: Id, text: String)

Index a document’s text

Source

pub fn remove_document(&mut self, id: &str)

Remove a document from the index

Source

pub fn bm25_scores(&self, query: &str) -> HashMap<Id, f32>

Compute BM25 scores for query terms

BM25 formula: score(D, Q) = Σ IDF(qi) * (f(qi, D) * (k1 + 1)) / (f(qi, D) + k1 * (1 - b + b * |D| / avgdl))

where:

  • IDF(qi) = log((N - df(qi) + 0.5) / (df(qi) + 0.5))
  • f(qi, D) = frequency of qi in document D
  • |D| = length of document D
  • avgdl = average document length
  • k1 = 1.2 (term frequency saturation)
  • b = 0.75 (length normalization)

Search for an exact phrase and return matching document IDs with scores

Uses position information to verify that terms appear consecutively. Returns BM25 scores with a phrase boost for exact matches.

Source

pub fn has_text(&self, id: &str) -> bool

Source

pub fn get_text(&self, id: &str) -> Option<&str>

Source

pub fn export_texts(&self) -> &HashMap<Id, String>

Export text data for persistence (Major Issue #6 fix)

Returns the texts HashMap which can be serialized and saved to disk. The inverted index, doc_lengths, and statistics are not exported since they can be rebuilt by re-tokenizing the texts on load.

Source

pub fn import_texts(&mut self, texts: HashMap<Id, String>)

Import text data from disk and rebuild the index (Major Issue #6 fix)

Takes a HashMap of texts loaded from disk and rebuilds the inverted index, doc_lengths, and statistics by re-tokenizing all texts. This allows the text index to survive store reopens and snapshots.

Trait Implementations§

Source§

impl Default for TextIndex

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more