~andrewzah/hangeul-rs

Mirror of https://github.com/azah/hangeul-rs/
add documentation for functions, add PartialEq to models
Update examples; add compose/ends_with_jongseong functions

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~andrewzah/hangeul-rs
read/write
git@git.sr.ht:~andrewzah/hangeul-rs

You can also use your local clone with git send-email.

#hangeul-rs

builds.sr.ht status docs badge crates version badge

A lightweight Korean alphabet manipulation library for Rust. No external crates are used.

Only modern, composable Korean unicode blocks are supported (AC00D7AF, 110011FF, 3130318F).

[dependencies]
hangeul = "0.2.0"

#Usage

extern crate hangeul;

fn main() {
    // literally: pikachu transliterated
    let subject = "피카츄";

    // Korean marks the topic of the sentence with a post position
    // particle: 이 follows consonants, and 가 follows vowels.
    let post_position = match hangeul::ends_in_consonant(subject).unwrap() {
        true => "이",
        false => "가"
    };

    // -> A wild pikachu has appeared!
    let sentence = format!("야생의 {}{} 나타났다!", subject, post_position);
    println!("{}", sentence); // 야생의 피카츄가 나타났다!

    // get_lead is an alias of get_choseong, to get the first character
    // of a Hangeul syllable.
    let sentence_in_choseong = sentence.chars()
                                .map(|c| hangeul::get_lead(&c).unwrap_or(c))
                                .collect::<String>();

    println!("{}", sentence_in_choseong); // ㅇㅅㅇ ㅍㅋㅊㄱ ㄴㅌㄴㄷ!
}

#Examples

Examples.

#Documentation

Docs.rs

#License

Distributed under MIT License