Struct rustdoc_seeker::RustDocSeeker

pub struct RustDocSeeker { /* fields omitted */ }

RustDocSeeker contains DocItems and Index for fast searching.

The index is kv-map for <name, idx: u64 = (start: u32 << 32) + end: u32> where items[start..end] having the same DocItem.name.

Example

let seeker = rustdoc.build();

Methods

impl RustDocSeeker

pub fn search<A: Automaton>(&self, aut: &A) -> impl Iterator<Item = &DocItem>

Search with fst::Automaton, read fst::automaton / fst-levenshtein / fst-regex for details.

Example

let aut = fst_regex::Regex::new(".*dedup.*").unwrap();
for i in seeker.search(aut) {
    println!("{:?}", i);
}

let aut = fst_levenshtein::Levenshtein::new("dedXp", 1).unwrap();
for i in seeker.search(aut) {
    println!("{:?}", i);
}

let aut = fst::automaton::Subsequence::new("dedup");
for i in seeker.search(aut) {
    println!("{:?}", i);
}

Trait Implementations

impl Debug for RustDocSeeker

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

Formats the value using the given formatter.