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
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

#[cfg(feature = "chinese")]
pub mod chinese;

pub mod dictionary;
pub mod error;
pub mod export;

#[cfg(feature = "laotian")]
pub mod laotian;

mod punctuation;
pub(crate) mod util;
pub mod word;

#[allow(unused_imports)]
use dictionary::{Chinese, Initializer, Lang, Laotian};

#[allow(unused_imports)]
use std::{collections::BTreeMap, path::PathBuf};
#[allow(unused_imports)]
use word::{Word, WordParser};

// Re export KeyVariant
pub use dodo_zh::variant::KeyVariant;

/// Load a chinese dictionnary allowing you to get a list of chinese definitions for a given sentence
///
/// # Arguments
///
/// * `version` - Lang
/// * `path` - PathBuf
///
/// # Example
///
/// ```
/// use std::path::PathBuf;
/// use xuexi::{
///     self,
///     KeyVariant,
///     dictionary::Lang,
///     word::WordParser
/// };
///
///
/// let chinese_dict = xuexi::load_chinese_dictionary(Lang::Chinese(KeyVariant::Traditional), PathBuf::from("./cedict_ts.u8")).unwrap();
/// let res = chinese_dict.parse_sentence_into_words("你好我是馬克的摯友");
///
/// assert_eq!(res.get("你好").unwrap().written, vec!["你好", "你好"]);
/// ```
#[cfg(feature = "chinese")]
pub fn load_chinese_dictionary(
    version: Lang,
    path: PathBuf,
) -> Result<dictionary::Dictionary<Chinese>, error::DictionaryError> {
    let mut dictionary = dictionary::Dictionary::<Chinese>::initialize(version)?;
    dictionary.load(path)?;

    Ok(dictionary)
}

/// Load a laotian dictionnary allowing you to get a list of laotian word definitions for a given sentence
///
/// # Arguments
///
/// * `path` - PathBuf
///
/// # Example
///
/// ```
/// use std::path::PathBuf;
/// use xuexi::{
///     self,
///     KeyVariant,
///     dictionary::Lang,
///     word::WordParser
/// };
///
/// let lao_dict = xuexi::load_laotian_dictionary(PathBuf::from("./lao-eng-dictionary.csv")).unwrap();
/// let res = lao_dict.parse_sentence_into_words("ມື້ນີ້ແມ່ນວັນຄຣິດສະມາດ");
///
/// assert_eq!(res.get("ມື້ນີ້").unwrap().written, vec!["ມື້ນີ້"]);
/// ```
#[cfg(feature = "laotian")]
pub fn load_laotian_dictionary(
    path: PathBuf,
) -> Result<dictionary::Dictionary<Laotian>, error::DictionaryError> {
    let mut dictionary = dictionary::Dictionary::<Laotian>::initialize(Lang::Laotian(None))?;
    dictionary.load(path)?;

    Ok(dictionary)
}