Skip to main content

Character

Enum Character 

Source
pub enum Character {
    NonHangul(char),
    Hangul(Jamo),
}
Expand description

An enum representing either a Hangul Jamo character or a non-Hangul character. Archaic or non-standard jamo like ᅀ will be classified as NonHangul because they are not used in standard modern Hangul syllable composition.

Variants§

§

NonHangul(char)

§

Hangul(Jamo)

Implementations§

Source§

impl Character

Source

pub fn from_char(c: char) -> Result<Self, JamoError>

Determines the type of Hangul letter for a given character. Archaic or non-standard jamo like ᅀ will be classified as NonHangul because they are not used in standard modern Hangul syllable composition. Classifies a character as Hangul jamo or non-Hangul and returns the appropriate Character enum variant.

Example:

use hangul_cd::jamo::{
    Character,
    Jamo,
    JamoConsonantSingular,
    JamoVowelSingular,
    JamoVowelComposite,
    JamoConsonantComposite,
};

// Valid Hangul consonant
assert_eq!(
    Character::from_char('ㄱ').unwrap(),
    Character::Hangul(Jamo::Consonant(JamoConsonantSingular::Giyeok))
);

// Valid Hangul vowel
assert_eq!(
    Character::from_char('ㅏ').unwrap(),
    Character::Hangul(Jamo::Vowel(JamoVowelSingular::A))
);

// Valid composite consonant
assert_eq!(
    Character::from_char('ㄲ').unwrap(),
    Character::Hangul(Jamo::CompositeConsonant(JamoConsonantComposite::SsangGiyeok))
);

// Valid composite vowel
assert_eq!(
    Character::from_char('ㅘ').unwrap(),
    Character::Hangul(Jamo::CompositeVowel(JamoVowelComposite::Wa))
);

// Non-Hangul character
assert_eq!(
    Character::from_char('A').unwrap(),
    Character::NonHangul('A')
);
Source

pub fn jamo(&self) -> Option<&Jamo>

Returns the Jamo if the Character is a Hangul jamo, or None otherwise.

Trait Implementations§

Source§

impl Clone for Character

Source§

fn clone(&self) -> Character

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Character

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Character

Source§

impl PartialEq for Character

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Character

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.