How it works

Search std docs

1. Build search index

The raw search index was generated by rustc-doc. The most important function is build_index() which located at librustdoc/html/render/

The final search index is an object array like this:

var searchIndex = [
      crate: "std",
      desc: "A hash map implemented with linear probing and Robin Hood bucket stealing.",
      name: "HashMap",
      parent: undefined,
      path: "std::collections",
      ty: 3,
      type: null
      crate: "std",
      desc: "Applies function to the elements of iterator and returns the first non-none result.",
      name: "find_map",
      parent: {ty: 8, name: "Iterator"},
      path: "std::iter",
      ty: 11,
      type: [["self"],["f"]]

2. Build search words array based on search index

The search words array is the list of search words to query against which build from the raw search index. It's just a plain name array of every Rust structs, traits, enums, functions, methods, macros, etc.

var searchWords = [

3. Search keyword in search words array

Using Levenshtein distance algorithm to search matched words, the max Levenshtein distance is 2.

// Max levenshtein distance.

4. Sort search result

Sort search result according to Levenshtein distance, lexicographical and others metrics.

5. Transform search result to suggestion result to show in the address bar

Mapping the search word and search index to generate the search result, build Rust doc link for each result item.

var suggestResults = [
      content: "",
      description: "std::ops::<match>Deref</match> - <dim>Used for immutable dereferencing operations, like `*v`.</dim>"
      content: "",
      description: "std::ops::Deref::<match>deref</match> - <dim>Dereferences the value.</dim>"

Search crates on

1. Build crates index

To be done...