Struct Hyw 

pub struct Hyw { /* private fields */ }

A combination of these characters.

Implementations

impl Hyw

pub const fn new() -> Self

Create a new Hyw.

pub const fn from_index(index: usize) -> Option<Self>

Create a Hyw from combined index. If the index is out of bounds, return None.

pub const fn to_index(&self) -> usize

Get the combined index of this Hyw.

pub const fn next(&self) -> Option<Self>

Get the next Hyw combination. If it is the last combination, return None.

pub const fn previous(&self) -> Option<Self>

Get the previous Hyw combination. If it is the first combination, return None.

pub const fn iter_from(self) -> HywIterator

Returns an iterator over all Hyw combinations starting from this one

pub const fn all() -> HywIterator

Returns an iterator over all possible Hyw combinations

pub const fn set_he(&mut self, he: usize) -> bool

Set the indice of character with pinyin “he”. If the index is out of bounds, return false and do not modify the value.

pub const fn set_yi(&mut self, yi: usize) -> bool

Set the indice of character with pinyin “yi”. If the index is out of bounds, return false and do not modify the value.

pub const fn set_wei(&mut self, wei: usize) -> bool

Set the indice of character with pinyin “wei”. If the index is out of bounds, return false and do not modify the value.

Trait Implementations

impl Clone for Hyw

fn clone(&self) -> Hyw

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Hyw

impl Debug for Hyw

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

Formats the value using the given formatter.

impl Default for Hyw

fn default() -> Self

Returns the “default value” for a type.

impl Display for Hyw

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

Formats the value using the given formatter.

impl Eq for Hyw

impl FromStr for Hyw

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Hyw

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