xuexi 0.1.5

utility to parse a sentence into words for multiple language
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

use crate::{error::DictionaryError, word::Word};
use chamkho::Wordcut;
use dodo_zh::variant::KeyVariant;
use std::{collections::HashMap, marker::PhantomData, path::PathBuf};

pub enum Lang {
    Chinese(KeyVariant),
    Laotian(Option<Box<Wordcut>>),
}

// Blanket state implementation used to initialize Dictionary for different language.
/// A Chinese dictionary
pub struct Chinese;
/// A Laotian dictionary
pub struct Laotian;

/// Dictionary contains the definitions of the dictionary.
/// A dictionary can support multiple language for multiple Initializer trait implementation
/// done through the usage of the PhantomData
///
/// The Dictionary struct usually implements the Initializer trait.
pub struct Dictionary<T> {
    pub _lang: PhantomData<T>,
    pub dict: HashMap<String, Word>,
    pub punctuation: Vec<String>,
    pub params: Lang,
}

pub(crate) trait Initializer<T> {
    /// Initialize the dictionary with default parameters
    ///
    /// # Arguments
    ///
    /// * `params` - Lang
    fn initialize(params: Lang) -> Result<Self, DictionaryError>
    where
        Self: Sized;

    /// Load the dictionary with the given file path (e.g: cedict, chamko...)
    ///
    /// # Arguemnts
    ///
    /// * `path` - PathBuf
    fn load(&mut self, path: PathBuf) -> Result<(), DictionaryError>;
}