Struct WordRef 

pub struct WordRef { /* private fields */ }

Word reference

Reference which points to a entry in the system or user dictionary. Similar to the WordId but the dict id part is a flag which indicates if it is a system or user word.

Top 4 bit is 0000 - points to the word in the system dictionary. Top 4 bit is 0001 - points to the word in the user dictionary which this wordref is used in.

Implementations

impl WordRef

pub const INVALID: WordRef

pub const fn from_raw(raw: u32) -> WordRef

Create WordRef from the compressed representation

pub fn new(is_system: bool, entry: u32) -> WordRef

Create a new WordRef

pub fn checked(is_system: bool, entry: u32) -> SudachiResult<WordRef>

Create a new WordRef with correctness checking

pub fn is_system(&self) -> bool

Check if the WordRef points to a system word

pub fn is_user(&self) -> bool

Check if the WordRef points to a user word

pub fn entry(&self) -> EntryId

Extract Entry ID

pub fn as_raw(&self) -> u32

Convert to raw representation

pub fn resolve(&self, dict: DictId) -> WordId

Resolve the WordRef with its DictId in the dictionary

pub fn resolve_raw(raw: u32, dict: DictId) -> u32

resolve raw

Trait Implementations

impl Clone for WordRef

fn clone(&self) -> WordRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WordRef

impl Debug for WordRef

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

Formats the value using the given formatter.

impl Default for WordRef

fn default() -> Self

Returns the “default value” for a type.

impl Display for WordRef

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

Formats the value using the given formatter.

impl Eq for WordRef

impl Hash for WordRef

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 Ord for WordRef

fn cmp(&self, other: &WordRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WordRef

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

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