Struct nlprule::types::Word

pub struct Word<'t> { /* fields omitted */ }

Contains all the local information about a token i. e. the text itself and the WordDatas associated with the word.

Implementations

impl<'t> Word<'t>

pub fn new(text: WordId<'t>, tags: Vec<WordData<'t>>) -> Self

Creates a new Word.

pub fn text(&self) -> &WordId<'t>

The text ID of this token.

pub fn tags(&self) -> &[WordData<'t>]

Multiple pairs of (lemma, part-of-speech) associated with this token. Order is in general not significant.

pub fn as_str(&'t self) -> &'t str

Gets the word text as string.

pub fn clear(&mut self)

Removes all non-frozen tags.

pub fn retain<F: FnMut(&WordData<'t>) -> bool>(&mut self, f: F)

Equivalent to Vec::retain on the tags but makes sure frozen tags are ignored.

pub fn push(&mut self, data: WordData<'t>)

Adds a new tag to the word.

pub fn to_owned_word(&self) -> Word

Converts to an owned word.

Trait Implementations

impl<'t> Clone for Word<'t>

fn clone(&self) -> Word<'t>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for Word<'t>

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

Formats the value using the given formatter.

impl<'t> PartialEq<Word<'t>> for Word<'t>

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

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

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

This method tests for !=.

impl<'t> StructuralPartialEq for Word<'t>