Struct SerializedSearchIndex 

pub(crate) struct SerializedSearchIndex {
    names: Vec<String>,
    path_data: Vec<Option<PathData>>,
    entry_data: Vec<Option<EntryData>>,
    descs: Vec<String>,
    function_data: Vec<Option<FunctionData>>,
    alias_pointers: Vec<Option<usize>>,
    type_data: Vec<Option<TypeData>>,
    generic_inverted_index: Vec<Vec<Vec<u32>>>,
    crate_paths_index: FxHashMap<(ItemType, Vec<Symbol>), usize>,
}

Fields

names: Vec<String>

path_data: Vec<Option<PathData>>

entry_data: Vec<Option<EntryData>>

descs: Vec<String>

function_data: Vec<Option<FunctionData>>

alias_pointers: Vec<Option<usize>>

type_data: Vec<Option<TypeData>>

generic_inverted_index: Vec<Vec<Vec<u32>>>

inverted index of generics

• The outermost list has one entry per alpha-normalized generic.

• The second layer is sorted by number of types that appear in the type signature. The search engine iterates over these in order from smallest to largest. Functions with less stuff in their type signature are more likely to be what the user wants, because we never show functions that are missing parts of the query, so removing..

• The final layer is the list of functions.

crate_paths_index: FxHashMap<(ItemType, Vec<Symbol>), usize>

Implementations

impl SerializedSearchIndex

fn load( doc_root: &Path, resource_suffix: &str, ) -> Result<SerializedSearchIndex, Error>

fn push( &mut self, name: String, path_data: Option<PathData>, entry_data: Option<EntryData>, desc: String, function_data: Option<FunctionData>, type_data: Option<TypeData>, alias_pointer: Option<usize>, ) -> usize

fn add_entry( &mut self, name: Symbol, entry_data: EntryData, desc: String, ) -> usize

Add potential search result to the database and return the row ID.

The returned ID can be used to attach more data to the search result.

fn push_path(&mut self, name: String, path_data: PathData) -> usize

fn push_type( &mut self, name: String, path_data: PathData, type_data: TypeData, ) -> usize

fn push_alias(&mut self, name: String, alias_pointer: usize) -> usize

fn get_id_by_module_path(&mut self, path: &[Symbol]) -> usize

pub(crate) fn union( self, other: &SerializedSearchIndex, ) -> SerializedSearchIndex

pub(crate) fn sort(self) -> SerializedSearchIndex

pub(crate) fn write_to( self, doc_root: &Path, resource_suffix: &str, ) -> Result<(), Error>

Trait Implementations

impl Clone for SerializedSearchIndex

fn clone(&self) -> SerializedSearchIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SerializedSearchIndex

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

Formats the value using the given formatter.

impl Default for SerializedSearchIndex

fn default() -> SerializedSearchIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SerializedSearchIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SerializedSearchIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 224 bytes