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

use std::{ffi::OsStr, fs::create_dir_all, fs::remove_dir_all, path::PathBuf};
use tantivy::{doc, tokenizer::TextAnalyzer, Index};

use crate::{
    config::DEFAULT_CONFIG_DIR,
    preview::PreviewOptions,
    schema::{ArchivedDictionary, ArchivedEntry, Dictionary},
};

use super::constants::{CUSTOM_TOKENIZER, DEFAULT_TOKENIZER};
use super::schema::{FIELD_BUFFER, FIELD_DEFINITIONS, FIELD_TERM, SCHEMA};

pub struct IndexOptions {
    pub memory: usize,
    pub dir: PathBuf,
    pub overwrite: bool,
    pub tokenizer: TextAnalyzer,
    pub cb_on_item: Box<dyn Fn(usize, &str) + Send + Sync>,
}

pub fn get_default_index_dir() -> PathBuf {
    DEFAULT_CONFIG_DIR.join(".idx")
}

impl IndexOptions {
    pub fn default() -> Self {
        Self {
            memory: 50_000_000,
            overwrite: false,
            tokenizer: DEFAULT_TOKENIZER.to_owned(),
            dir: get_default_index_dir(),
            cb_on_item: Box::new(|_, _| {}),
        }
    }

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

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

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

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

    pub fn on_item<F>(mut self, callback: F) -> Self
    where
        F: Fn(usize, &str) + Send + Sync + 'static,
    {
        self.cb_on_item = Box::new(callback);
        self
    }
}

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

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

            if opts.overwrite && index_path.exists() {
                remove_dir_all(&index_path)?;
            }

            if !index_path.exists() {
                create_dir_all(&index_path)?;
            }

            let index = Index::create_in_dir(&index_path, SCHEMA.to_owned())?;

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

            let mut index_writer = index.writer(opts.memory)?;

            self.entries.iter().enumerate().for_each(|(i, entry)| {
                let document = doc!(
                  *FIELD_TERM => entry.term.as_str(),
                  *FIELD_DEFINITIONS => entry.preview(PreviewOptions::default()),
                  *FIELD_BUFFER => entry.serialize().unwrap()
                );

                if index_writer.add_document(document).is_ok() {
                    let cb = options.as_ref().cb_on_item.as_ref();
                    cb(i, entry.term.as_str());
                }
            });

            index_writer.commit()?;
            index_writer.wait_merging_threads()?;

            Ok(())
        }
    }
    };
}

trait SerializeEntry {
    fn serialize(&self) -> crate::Result<Vec<u8>>;
}

impl SerializeEntry for &ArchivedEntry {
    fn serialize(&self) -> crate::Result<Vec<u8>> {
        self.deserialize().unwrap().serialize()
    }
}

index!(Dictionary);
index!(ArchivedDictionary);