Struct PinyinData 

pub struct PinyinData { /* private fields */ }

Available on crate feature pinyin only.

Memory usage

Per pinyin notation: 8 * 1514 ≈ 11.8 KiB.

• Unicode does not require extra memory.
• AsciiFirstLetter uses the same storage as Ascii.

Others

TODO: Optionally generate pinyin notation data at build time.

Less flexible at runtime.

TODO: Is row-major order more cache friendly?

Row-major order requires 7 * 8 * 1514 ≈ 83 KiB, dynamic columns are needed to reduce memory usage. And dynamic columns can also offer better cache locality.

TODO: Order pinyin by frequency to improve cache locality?

Implementations

impl PinyinData

pub fn new(notations: PinyinNotation) -> Self

pub fn init_notations(&self, notations: PinyinNotation)

Available on crate feature inmut-data only.

pub fn inited_notations(&self) -> PinyinNotation

pub fn iter(&self) -> impl Iterator<Item = Pinyin<'_>>

pub fn get_pinyins<'a>( &'a self, c: char, ) -> Box<dyn Iterator<Item = Pinyin<'a>> + 'a>

Prefer PinyinData::get_pinyins_and_for_each and PinyinData::get_pinyins_and_try_for_each if applicable.

Performance

Do not use this method in performance-critical code. The Box wouldn’t be optimized away even with #[inline(always)].

pub fn get_pinyins_and_for_each(&self, c: char, f: impl FnMut(Pinyin<'_>))

pub fn get_pinyins_and_try_for_each<T>( &self, c: char, f: impl FnMut(Pinyin<'_>) -> Option<T>, ) -> Option<T>

pub fn match_pinyin<'a: 'h, 'h>( &'a self, notation: PinyinNotation, haystack: &'h str, ) -> impl Iterator<Item = &'a str> + 'h

Match pinyin of the given notation in haystack.

pub fn match_pinyin_partial<'a: 'h, 'h>( &'a self, notation: PinyinNotation, haystack: &'h str, partial: bool, ) -> impl Iterator<Item = (&'a str, bool)> + 'h

Match pinyin of the given notation in haystack, optionally allowing partial matches.

Returns

(pinyin, partial)

• If partial is true, haystack.len() < pinyin.len().

Trait Implementations

impl Clone for PinyinData

fn clone(&self) -> PinyinData

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.