Struct InvertedIndex

pub struct InvertedIndex { /* private fields */ }

Implements an elasticlunr.js inverted index. Most users do not need to use this type directly.

Implementations

impl InvertedIndex

pub fn new() -> Self

pub fn add_token(&mut self, doc_ref: &str, token: &str, term_freq: f64)

pub fn has_token(&self, token: &str) -> bool

pub fn remove_token(&mut self, doc_ref: &str, token: &str)

pub fn get_docs(&self, token: &str) -> Option<BTreeMap<String, f64>>

pub fn get_term_frequency(&self, doc_ref: &str, token: &str) -> f64

pub fn get_doc_frequency(&self, token: &str) -> i64

Trait Implementations

impl Debug for InvertedIndex

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

Formats the value using the given formatter.

impl Default for InvertedIndex

fn default() -> InvertedIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InvertedIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InvertedIndex

fn eq(&self, other: &InvertedIndex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InvertedIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InvertedIndex