Struct WordId

pub struct WordId { /* private fields */ }

An identifier for a particular word.

It works by hashing the word it represents, normalized to lowercase. It is meant for situations where you need to refer to a word (or a collection of words), without storing all of accompanying data (like spelling or metadata).

Implementations

impl WordId

pub fn from_word_chars(chars: impl AsRef<[char]>) -> Self

Create a Word ID from a character slice.

pub fn from_word_str(text: impl AsRef<str>) -> Self

Create a word ID from a string. Requires allocation, so use sparingly.

Trait Implementations

impl Clone for WordId

fn clone(&self) -> WordId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WordId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WordId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for WordId

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 WordId

fn eq(&self, other: &WordId) -> 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 WordId

fn partial_cmp(&self, other: &WordId) -> 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 WordId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for WordId

impl Eq for WordId

impl StructuralPartialEq for WordId