dictx-core 0.1.0

Core data types and query models for DictX terminal dictionary.
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum Query {
    Exact { word: String },
    Fuzzy { word: String, distance: u8 },
    FullText { text: String },
    Chinese { text: String },
    Wildcard { pattern: String },
}

impl Query {
    pub fn user_text(&self) -> &str {
        match self {
            Self::Exact { word } => word,
            Self::Fuzzy { word, .. } => word,
            Self::FullText { text } => text,
            Self::Chinese { text } => text,
            Self::Wildcard { pattern } => pattern,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct SearchFilters {
    pub source: Option<String>,
    pub pos: Option<String>,
    pub tag: Option<String>,
    pub collins_min: Option<u8>,
    pub freq_min: Option<u32>,
    pub freq_max: Option<u32>,
    pub oxford_only: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct SearchRequest {
    pub query: Query,
    pub filters: SearchFilters,
    pub limit: usize,
    pub offset: usize,
}

impl SearchRequest {
    pub fn new(query: Query) -> Self {
        Self {
            query,
            filters: SearchFilters::default(),
            limit: 20,
            offset: 0,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn user_text_returns_visible_query() {
        assert_eq!(
            Query::Fuzzy {
                word: "appple".to_string(),
                distance: 2
            }
            .user_text(),
            "appple"
        );
    }
}