Crate chinese_dictionary

Source
Expand description

§About

A searchable Chinese / English dictionary with helpful utilities.

§Features

  • Search with Traditional Chinese characters, Simplified Chinese characters, pinyin with tone marks, pinyin with tone numbers, pinyin with no tones, and English.
  • Classify a string of text as either English, pinyin, or Chinese characters.
  • Convert between Traditional and Simplified Chinese characters.
  • Segment strings of Chinese characters into tokens using a dictionary-driven segmentation approach.

§Usage

Querying the dictionary

extern crate chinese_dictionary;

use chinese_dictionary::query;

// Querying the dictionary returns an `Option<Vec<&WordEntry>>`
// Read more about the WordEntry struct below
let text = "to run";
let results = query(text).unwrap();
assert_eq!("执行", results[0].simplified);

Classifying a string of text

extern crate chinese_dictionary;

use chinese_dictionary::{classify, ClassificationResult};

// Read more about the ClassificationResult enum below
assert_eq!(ClassificationResult::PY, classify("nihao"));

Convert between Traditional and Simplified Chinese characters

extern crate chinese_dictionary;

use chinese_dictionary::{traditional_to_simplified, simplified_to_traditional};

assert_eq!("简体字", traditional_to_simplified("簡體字"));
assert_eq!("繁體字", simplified_to_traditional("繁体字"));

Segment a string of characters

extern crate chinese_dictionary;

use chinese_dictionary::{tokenize};

assert_eq!(vec!["今天", "天气", "不错"], tokenize("今天天气不错"));
§WordEntry struct
extern crate chinese_dictionary;

use chinese_dictionary::{MeasureWord, WordEntry};

let example_measure_word = MeasureWord {
    traditional: "example_traditional".to_string(),
    simplified: "example_simplified".to_string(),
    pinyin_marks: "example_pinyin_marks".to_string(),
    pinyin_numbers: "example_pinyin_numbers".to_string(),
};

let example = WordEntry {
    traditional: "繁體字".to_string(),
    simplified: "繁体字".to_string(),
    pinyin_marks: "fán tǐ zì".to_string(),
    pinyin_numbers: "fan2 ti3 zi4".to_string(),
    english: vec!["traditional Chinese character".to_string()],
    tone_marks: vec![2 as u8, 3 as u8, 4 as u8],
    hash: 000000 as u64,
    measure_words: vec![example_measure_word],
    hsk: 6 as u8,
    word_id: 11111111 as u32,
};
§ClassificationResult enum

The possible values for the ClassificationResult enum are:

  • PY: Represents Pinyin
  • EN: Represents English
  • ZH: Represents Chinese
  • UN: Represents an uncertain classification result

Structs§

MeasureWord
WordEntry

Enums§

ClassificationResult

Functions§

classify
init
is_simplified
is_traditional
query
Query
query_by_chinese
Query by Chinese
query_by_english
Query by English
query_by_pinyin
Query by Pinyin
query_by_simplified
Query by exact Simplified Chinese word
query_by_traditional
Query by exact Traditional Chinese word
simplified_to_traditional
tokenize
traditional_to_simplified