Crate wana_kana

ワナカナ <–> WanaKana <–> わなかな

Utility library for checking and converting between Japanese characters - Hiragana, Katakana - and Romaji (Ported from https://github.com/WaniKani/WanaKana)

Conversions

We provide the ConvertJapanese Trait, which is implemented for &str, that allows the same conversions as mentioned above, by calling the corresponding method directly on the &str.

use wana_kana::ConvertJapanese;
// to kana
assert_eq!("o".to_kana(), "お");
assert_eq!("ona".to_kana(), "おな");
assert_eq!("onaji".to_kana(), "おなじ");
assert_eq!("onaji BUTTSUUJI".to_kana(), "おなじ ブッツウジ");
assert_eq!("ONAJI buttsuuji".to_kana(), "オナジ ぶっつうじ");
assert_eq!("座禅‘zazen’スタイル".to_kana(), "座禅「ざぜん」スタイル");
// to hiragana
assert_eq!("toukyou,オオサカ".to_hiragana(), "とうきょう、おおさか");
// to katakana
assert_eq!("toukyou,おおさか".to_katakana(), "トウキョウ、オオサカ");
// to romaji
assert_eq!("ひらがな　カタカナ".to_romaji(), "hiragana katakana");

To check whether a string is Japanese, romaji, kana, etc, use the is_* functions in is_* modules, or equivalently use the IsJapaneseStr trait. There are also functions to check a single char available in the utils module, and the corresponding trait is IsJapaneseChar. Refer to the links for detailed information.

Re-exports

pub use traits::ConvertJapanese;

pub use traits::IsJapaneseChar;

pub use traits::IsJapaneseStr;

Modules

constants

is_hiragana

Test if all chars of input are Hiragana

is_japanese

Test if input only includes Kanji, Kana, zenkaku punctuation, japanese symbols and numbers.

is_kana

Test if all chars of input are Kana (Katakana and/or Hiragana)

is_kanji

Test if all chars of input are Kanji (Japanese CJK ideographs)

is_katakana

Test if all chars of input are Katakana

is_mixed

Test if input contains a mix of Romaji and Kana, defaults to pass through Kanji

is_romaji

Test if every char in input is Romaji (allowing Hepburn romanisation)

to_hiragana

Convert input to Hiragana

to_kana

Convert Romaji to Kana, lowercase text will result in Hiragana and uppercase text will result in Katakana.

to_katakana

Convert input to Katakana

to_romaji

Convert kana to romaji

tokenize

Splits input into array of strings separated by opinionated token types

traits

trim_okurigana

Strips trailing Okurigana if input is a mix of Kanji and Kana

utils

Macros

hashmap

Structs

Options