Struct FstDictionary 

pub struct FstDictionary { /* private fields */ }

Dictionary backed by a Gukhanmun FST file.

The fixed header and CBOR metadata are decoded eagerly. The FST map bytes and reading table share one backing byte source: owned heap bytes for FstDictionary::open and FstDictionary::from_bytes, or static bytes for FstDictionary::from_static_bytes.

Implementations

impl FstDictionary

pub fn open(path: impl AsRef<Path>) -> Result<FstDictionary, Error>

Opens a dictionary file from disk.

pub fn from_bytes(bytes: &[u8]) -> Result<FstDictionary, Error>

Decodes a dictionary from bytes in the Gukhanmun FST file format.

pub fn from_static_bytes(bytes: &'static [u8]) -> Result<FstDictionary, Error>

Decodes a dictionary from static bytes in the Gukhanmun FST file format.

This is intended for embedded dictionaries built with include_bytes!. The FST map and reading table borrow from the static byte slice without copying either section.

pub fn metadata(&self) -> &BTreeMap<String, String>

Returns build metadata embedded in the dictionary file.

pub fn entry_count(&self) -> u64

Returns the number of entries recorded at build time.

pub fn lookup(&self, hanja: &str) -> Result<Option<LookupEntry>, Error>

Returns the exact dictionary entry for hanja, if present.

Trait Implementations

impl Clone for FstDictionary

fn clone(&self) -> FstDictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FstDictionary

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl HanjaDictionary for FstDictionary

fn matches_at<'a>(&'a self, s: &'a str) -> Box<dyn Iterator<Item = Match> + 'a>

Yields every dictionary match that starts at the beginning of s.

fn max_word_chars(&self) -> Option<usize>

Returns the greatest dictionary entry length in Unicode scalar values.

fn entries<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = DictionaryRecord> + 'a>>

Enumerates complete dictionary entries when the backend supports it.

fn has_homophone(&self, hanja: &str, reading: &str) -> bool

Returns whether another hanja spelling has the same hangul reading.