ib_pinyin/lib.rs
1//! 一个高性能拼音查询、匹配库。
2//!
3//! - 支持以下拼音编码方案：
4//! - 简拼（“py”）
5//! - 全拼（“pinyin”）
6//! - 带声调全拼（“pin1yin1”）
7//! - Unicode（“pīnyīn”）
8//! - 智能 ABC 双拼
9//! - 拼音加加双拼
10//! - 微软双拼
11//! - 华宇双拼（紫光双拼）
12//! - 小鹤双拼
13//! - 自然码双拼
14//! - 支持多音字。
15//! - 支持混合匹配多种拼音编码方案，默认匹配简拼和全拼。
16//! - 默认小写字母匹配拼音或字母，大写字母只匹配字母。
17//! - 支持 Unicode 辅助平面汉字。
18//!
19//! ## Usage
20//! ```
21//! use ib_pinyin::{matcher::PinyinMatcher, pinyin::PinyinNotation};
22//!
23//! let matcher = PinyinMatcher::builder("pysousuoeve")
24//! .pinyin_notations(PinyinNotation::Ascii | PinyinNotation::AsciiFirstLetter)
25//! .build();
26//! assert!(matcher.is_match("拼音搜索Everything"));
27//! ```
28//!
29//! ## Features
30#![cfg_attr(docsrs, feature(doc_auto_cfg))]
31#![cfg_attr(feature = "doc", doc = document_features::document_features!())]
32pub mod matcher;
33#[cfg(feature = "minimal")]
34pub mod minimal;
35pub mod pinyin;