Struct jp_inflections::Word

pub struct Word {
    pub kana: String,
    pub kanji: Option<String>,
    pub inflections: Vec<Inflection>,
}

Represents a japanese word

Fields

kana: String

kanji: Option<String>

inflections: Vec<Inflection>

Implementations

impl Word

pub fn new<S: AsRef<str>>(kana: S, kanji: Option<S>) -> Word

Creates a new Word value of a kana and optionally kanji word. Requires both words to be in the dictionary form

pub fn is_verb(&self) -> bool

Returns true if the Word is a verb

Example

use jp_inflections::Word;

assert!(Word::new("ならう", Some("習う")).is_verb());
assert!(!Word::new("えいご", Some("英語")).is_verb());

pub fn into_verb(self, verb_type: VerbType) -> Result<Verb, Error>

Returns a verb from the word. Requires the word to be a verb in the dictionary form

Example

use jp_inflections::{Word, VerbType};

assert!(Word::new("ならう", Some("習う")).into_verb(VerbType::Godan).is_ok());

pub fn has_reading(&self, kana: &str, kanji: Option<&str>) -> bool

Returns true if self has the passed readings. If kanji is none, but the word has a kanji reading the output represents only a kana match

pub fn ends_with(&self, kana: &str, kanji: Option<&str>) -> bool

Returns true if the words readings end with the passed strings. If the kanji is none, but the word has a kanji reading the output represents only a kana match

pub fn get_reading(&self) -> String

Returns the kanji reading if possible, otherwise the kana reading gets returned

Trait Implementations

impl Clone for Word

fn clone(&self) -> Word

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Word

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

Formats the value using the given formatter.

impl PartialEq<Word> for Word

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

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

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

This method tests for !=.

impl StructuralPartialEq for Word