Struct SimpleSearchIndex 

pub struct SimpleSearchIndex {
    pub version: u32,
    pub documents: Vec<SimpleDocument>,
    pub index: HashMap<String, Vec<usize>>,
}

A simple JSON-based search index.

Fields

version: u32

Index format version.

documents: Vec<SimpleDocument>

All indexed documents.

index: HashMap<String, Vec<usize>>

Inverted index: term -> document indices.

Implementations

impl SimpleSearchIndex

pub fn new() -> Self

Create a new empty index.

pub fn from_pages(pages: &[&Page]) -> Self

Build an index from a collection of pages.

pub fn add_page(&mut self, page: &Page)

Add a page to the index.

pub fn search(&self, query: &str) -> Vec<&SimpleDocument>

Search the index for matching documents.

Returns documents matching all query terms (AND search).

pub fn to_json(&self) -> Result<String, SearchError>

Serialize the index to JSON.

pub fn to_json_pretty(&self) -> Result<String, SearchError>

Serialize the index to pretty-printed JSON.

pub fn from_json(json: &str) -> Result<Self, SearchError>

Deserialize an index from JSON.

pub fn write_to_file(&self, path: &Path) -> Result<(), SearchError>

Write the index to a file.

pub fn estimated_size(&self) -> usize

Get the estimated size of the serialized index.

pub fn is_within_size_limit(&self) -> bool

Check if the index is within the recommended size limit.

Trait Implementations

impl Clone for SimpleSearchIndex

fn clone(&self) -> SimpleSearchIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimpleSearchIndex

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

Formats the value using the given formatter.

impl Default for SimpleSearchIndex

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SimpleSearchIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SimpleSearchIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.