odict 3.1.1

A blazingly-fast dictionary file format for human languages
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use rkyv::util::AlignedVec;

use std::{ffi::OsStr, path::PathBuf};

use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
use rkyv::access_unchecked;
use tantivy::schema::Value;
use tantivy::TantivyDocument;
use tantivy::{
    collector::TopDocs, query::QueryParser, tokenizer::TextAnalyzer, Index, ReloadPolicy,
};

use crate::schema::{ArchivedDictionary, Dictionary, Entry};

use super::constants::{CUSTOM_TOKENIZER, DEFAULT_TOKENIZER};
use super::index::IndexOptions;

use super::{
    index::get_default_index_dir,
    schema::{FIELD_BUFFER, FIELD_DEFINITIONS, FIELD_TERM},
};

pub struct SearchOptions {
    pub dir: PathBuf,
    pub threshold: u32,
    pub autoindex: bool,
    pub limit: usize,
    pub tokenizer: TextAnalyzer,
}

impl SearchOptions {
    pub fn default() -> Self {
        Self {
            dir: get_default_index_dir(),
            threshold: 1,
            autoindex: false,
            limit: 10,
            tokenizer: DEFAULT_TOKENIZER.to_owned(),
        }
    }

    pub fn limit(mut self, limit: usize) -> Self {
        self.limit = limit;
        self
    }

    pub fn autoindex(mut self, autoindex: bool) -> Self {
        self.autoindex = autoindex;
        self
    }

    pub fn tokenizer<T>(mut self, tokenizer: T) -> Self
    where
        TextAnalyzer: From<T>,
    {
        self.tokenizer = tokenizer.into();
        self
    }

    pub fn threshold(mut self, threshold: u32) -> Self {
        self.threshold = threshold;
        self
    }

    pub fn dir<P: AsRef<OsStr> + ?Sized>(mut self, dir: &P) -> Self {
        self.dir = PathBuf::from(dir);
        self
    }
}

impl AsRef<SearchOptions> for SearchOptions {
    fn as_ref(&self) -> &SearchOptions {
        self
    }
}

macro_rules! search {
    ($name:ident) => {
        impl $name {
            pub fn search<Options: AsRef<SearchOptions>>(
                &self,
                query: &str,
                options: Options,
            ) -> crate::Result<Vec<Entry>> {
                let opts = options.as_ref();
                let index_path = opts.dir.join(self.id.as_str());

                if opts.autoindex {
                    if !index_path.exists() {
                        self.index(IndexOptions::default().tokenizer(opts.tokenizer.clone()))?;
                    }
                }

                let index = Index::open_in_dir(&index_path)?;

                index
                    .tokenizers()
                    .register(CUSTOM_TOKENIZER, opts.tokenizer.to_owned());

                let reader = index
                    .reader_builder()
                    .reload_policy(ReloadPolicy::OnCommitWithDelay)
                    .try_into()?;

                let searcher = reader.searcher();
                let query_parser =
                    QueryParser::for_index(&index, vec![*FIELD_TERM, *FIELD_DEFINITIONS]);
                let query_obj = query_parser.parse_query(query)?;
                let top_docs = searcher.search(&query_obj, &TopDocs::with_limit(opts.limit))?;
                let entries = top_docs
                    .par_iter()
                    .filter(|(score, _)| score >= &(opts.threshold as f32))
                    .map(|(_, doc_address)| -> Entry {
                        let retrieved_doc: TantivyDocument = searcher.doc(*doc_address).unwrap();

                        let bytes = retrieved_doc
                            .get_first(*FIELD_BUFFER)
                            .unwrap()
                            .as_bytes()
                            .unwrap();

                        let mut aligned_vec = AlignedVec::<4096>::new();

                        aligned_vec.extend_from_slice(bytes);

                        let archive = unsafe {
                            access_unchecked::<crate::schema::ArchivedEntry>(&aligned_vec)
                        };

                        archive.deserialize().unwrap()
                    })
                    .collect();

                Ok(entries)
            }
        }
    };
}

search!(Dictionary);
search!(ArchivedDictionary);