Struct kanji::Katakana

pub struct Katakana(_);

A Katakana character, from ア to ン.

These are typically learned after Hiragana, and are used to represent foreign names, sound effects, and occasionally words whose Kanji are "difficult". Two such examples are ネズミ (鼠) and アリ (蟻).

It used to be common to use Katakana as Hiragana are used today, so the phrase君と街を歩きたい would have been written 君ト街ヲ歩キタイ. Admittedly strange to modern eyes!

Implementations

impl Katakana

pub fn new(c: char) -> Option<Katakana>

Attempt to form a Katakana. Will fail if the given char is out of the expected Unicode range.

use kanji::Katakana;

assert_eq!(Some('ア'), Katakana::new('ア').map(|k| k.get()));
assert_eq!(None, Katakana::new('匙'));
assert_eq!(None, Katakana::new('a'));

pub fn get(&self) -> char

Pull out the inner char.

Trait Implementations

impl Clone for Katakana

fn clone(&self) -> Katakana

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Katakana

impl Debug for Katakana

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Katakana

impl Hash for Katakana

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Katakana

fn cmp(&self, other: &Katakana) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Katakana> for Katakana

fn eq(&self, other: &Katakana) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Katakana) -> bool

This method tests for !=.

impl PartialOrd<Katakana> for Katakana

fn partial_cmp(&self, other: &Katakana) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Katakana) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Katakana) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Katakana) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Katakana) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Katakana

impl StructuralPartialEq for Katakana