Struct WordMetadata

pub struct WordMetadata {

    pub noun: Option<NounData>,
    pub pronoun: Option<PronounData>,
    pub verb: Option<VerbData>,
    pub adjective: Option<AdjectiveData>,
    pub adverb: Option<AdverbData>,
    pub conjunction: Option<ConjunctionData>,
    pub swear: Option<bool>,
    pub dialects: DialectFlags,
    pub determiner: Option<DeterminerData>,
    pub preposition: bool,
    pub common: bool,
    pub derived_from: Option<WordId>,
    pub np_member: Option<bool>,
    pub pos_tag: Option<UPOS>,
}

Fields

noun: Option<NounData>

pronoun: Option<PronounData>

verb: Option<VerbData>

adjective: Option<AdjectiveData>

adverb: Option<AdverbData>

conjunction: Option<ConjunctionData>

swear: Option<bool>

dialects: DialectFlags

The dialects this word belongs to. If no dialects are defined, it can be assumed that the word is valid in all dialects of English.

determiner: Option<DeterminerData>

Whether the word is a determiner.

preposition: bool

Whether the word is a preposition.

common: bool

Whether the word is considered especially common.

derived_from: Option<WordId>

np_member: Option<bool>

Generated by a chunker

pos_tag: Option<UPOS>

Generated by a POS tagger

Implementations

impl WordMetadata

pub fn or(&self, other: &Self) -> Self

Produce a copy of self with the known properties of other set.

pub fn enforce_pos_exclusivity(&mut self, pos: &UPOS)

Given a UPOS tag, discard any metadata that would disagree with the given POS tag. For example, if the metadata suggests a word could either be a noun or an adjective, and we provide a UPOS::NOUN, this function will remove the adjective data.

Additionally, if the metadata does not currently declare the potential of the word to be the specific POS, it becomes so. That means if we provide a UPOS::ADJ to the function for a metadata whose Self::adjective = None, it will become Some.

pub fn is_likely_homograph(&self) -> bool

pub fn is_noun(&self) -> bool

Checks if the word is definitely a noun.

pub fn is_proper_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as (a) proper.

pub fn is_non_proper_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as not (a) proper.

pub fn is_plural_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as (a) plural.

pub fn is_non_plural_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as not (a) plural.

pub fn is_mass_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as (a) mass.

pub fn is_non_mass_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as not (a) mass.

pub fn is_possessive_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as (a) possessive.

pub fn is_non_possessive_noun(&self) -> bool

Checks if the word is definitely a noun and more specifically is labeled as not (a) possessive.

pub fn is_pronoun(&self) -> bool

Checks if the word is definitely a pronoun.

pub fn is_personal_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as (a) personal.

pub fn is_non_personal_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as not (a) personal.

pub fn is_singular_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as (a) singular.

pub fn is_non_singular_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as not (a) singular.

pub fn is_plural_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as (a) plural.

pub fn is_non_plural_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as not (a) plural.

pub fn is_possessive_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as (a) possessive.

pub fn is_non_possessive_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as not (a) possessive.

pub fn is_reflexive_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as (a) reflexive.

pub fn is_non_reflexive_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as not (a) reflexive.

pub fn is_subject_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as (a) subject.

pub fn is_non_subject_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as not (a) subject.

pub fn is_object_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as (a) object.

pub fn is_non_object_pronoun(&self) -> bool

Checks if the word is definitely a pronoun and more specifically is labeled as not (a) object.

pub fn is_determiner(&self) -> bool

Checks if the word is definitely a determiner.

pub fn is_demonstrative_determiner(&self) -> bool

Checks if the word is definitely a determiner and more specifically is labeled as (a) demonstrative.

pub fn is_non_demonstrative_determiner(&self) -> bool

Checks if the word is definitely a determiner and more specifically is labeled as not (a) demonstrative.

pub fn is_possessive_determiner(&self) -> bool

Checks if the word is definitely a determiner and more specifically is labeled as (a) possessive.

pub fn is_non_possessive_determiner(&self) -> bool

Checks if the word is definitely a determiner and more specifically is labeled as not (a) possessive.

pub fn is_quantifier_determiner(&self) -> bool

Checks if the word is definitely a determiner and more specifically is labeled as (a) quantifier.

pub fn is_non_quantifier_determiner(&self) -> bool

Checks if the word is definitely a determiner and more specifically is labeled as not (a) quantifier.

pub fn is_verb(&self) -> bool

Checks if the word is definitely a verb.

pub fn is_linking_verb(&self) -> bool

Checks if the word is definitely a verb and more specifically is labeled as (a) linking.

pub fn is_non_linking_verb(&self) -> bool

Checks if the word is definitely a verb and more specifically is labeled as not (a) linking.

pub fn is_auxiliary_verb(&self) -> bool

Checks if the word is definitely a verb and more specifically is labeled as (a) auxiliary.

pub fn is_non_auxiliary_verb(&self) -> bool

Checks if the word is definitely a verb and more specifically is labeled as not (a) auxiliary.

pub fn is_conjunction(&self) -> bool

Checks if the word is definitely a conjunction.

pub fn is_adjective(&self) -> bool

Checks if the word is definitely a adjective.

pub fn is_adverb(&self) -> bool

Checks if the word is definitely a adverb.

pub fn is_first_person_plural_pronoun(&self) -> bool

pub fn is_first_person_singular_pronoun(&self) -> bool

pub fn is_third_person_plural_pronoun(&self) -> bool

pub fn is_third_person_singular_pronoun(&self) -> bool

pub fn is_third_person_pronoun(&self) -> bool

pub fn is_second_person_pronoun(&self) -> bool

pub fn is_verb_lemma(&self) -> bool

pub fn is_verb_past_form(&self) -> bool

pub fn is_verb_progressive_form(&self) -> bool

pub fn is_verb_third_person_singular_present_form(&self) -> bool

pub fn is_singular_noun(&self) -> bool

pub fn is_non_singular_noun(&self) -> bool

pub fn is_countable_noun(&self) -> bool

pub fn is_non_countable_noun(&self) -> bool

pub fn is_mass_noun_only(&self) -> bool

pub fn is_nominal(&self) -> bool

Checks if the word is definitely nominal.

pub fn is_singular_nominal(&self) -> bool

Checks if the word is definitely a nominal and more specifically is labeled as (a) singular.

pub fn is_plural_nominal(&self) -> bool

Checks if the word is definitely a nominal and more specifically is labeled as (a) plural.

pub fn is_possessive_nominal(&self) -> bool

Checks if the word is definitely a nominal and more specifically is labeled as (a) possessive.

pub fn is_non_singular_nominal(&self) -> bool

Checks if the word is definitely a nominal and more specifically is labeled as not (a) singular.

pub fn is_non_plural_nominal(&self) -> bool

Checks if the word is definitely a nominal and more specifically is labeled as not (a) plural.

pub fn is_non_possessive_nominal(&self) -> bool

Checks if the word is definitely a nominal and more specifically is labeled as not (a) possessive.

pub fn is_quantifier(&self) -> bool

pub fn is_swear(&self) -> bool

Checks whether a word is definitely a swear.

pub fn append(&mut self, other: &Self) -> &mut Self

Same thing as Self::or, except in-place rather than a clone.

Trait Implementations

impl Clone for WordMetadata

fn clone(&self) -> WordMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WordMetadata

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

Formats the value using the given formatter.

impl Default for WordMetadata

fn default() -> WordMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WordMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for WordMetadata

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WordMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for WordMetadata

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for WordMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WordMetadata

impl StructuralPartialEq for WordMetadata