Struct SearchIndex

pub struct SearchIndex {
    pub docnames: Vec<String>,
    pub filenames: Vec<String>,
    pub titles: Vec<String>,
    pub terms: HashMap<String, Vec<DocumentMatch>>,
    pub objects: HashMap<String, ObjectReference>,
    pub objnames: HashMap<String, String>,
    pub objtypes: HashMap<String, String>,
    pub language: String,
}

Search index that mirrors Sphinx’s search functionality

Fields

docnames: Vec<String>

filenames: Vec<String>

titles: Vec<String>

terms: HashMap<String, Vec<DocumentMatch>>

objects: HashMap<String, ObjectReference>

objnames: HashMap<String, String>

objtypes: HashMap<String, String>

language: String

Implementations

impl SearchIndex

pub fn new(language: String) -> Self

pub fn add_document( &mut self, docname: String, filename: String, title: String, content: &str, ) -> Result<()>

Add a document to the search index

pub fn add_object( &mut self, name: String, docname: &str, anchor: Option<String>, obj_type: &str, description: Option<String>, ) -> Result<()>

Add an object to the search index

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

Search for documents matching a query

pub fn prune(&mut self, valid_docs: &HashSet<String>)

Prune the search index by removing documents not in the given set

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

Export search index to JSON format compatible with Sphinx

Trait Implementations

impl Clone for SearchIndex

fn clone(&self) -> SearchIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchIndex

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

Formats the value using the given formatter.

impl Default for SearchIndex

fn default() -> SearchIndex

Returns the “default value” for a type.