Struct Tile 

pub struct Tile(/* private fields */);

Represents one tile (牌).

Encoded as a 6-bit integer:

Encoding	Shorthand	Category (EN)	Category (JP)
0 ..= 8	1m ..= 9m	characters	萬子
9 ..= 17	1p ..= 9p	dots	筒子
18 ..= 26	1s ..= 9s	bamboos	索子
27 ..= 30	1z ..= 4z	winds	風牌
31, 32, 33	5z, 6z, 7z	dragons	三元牌
34, 35, 36	0m, 0p, 0s	reds	赤牌

Note that only red 5’s can be represented (not other numbers or honors).

Details of this encoding is significant and implicitly assumed across the crate. It should never be changed.

Optional serde support

The common string shorthand (e.g. "1m", "0p", "7z") is used as the serialization format. This ensures readability and interoperability.

Implementations

impl Tile

pub const MIN_ENCODING: u8 = 0u8

pub const MAX_ENCODING: u8 = 36u8

pub const MIN: Self

pub const MAX: Self

pub const fn from_encoding(encoding: u8) -> Option<Self>

pub const fn from_num_suit(num: u8, suit: u8) -> Option<Self>

pub fn from_wind(wind: Wind) -> Self

pub const fn is_valid(self) -> bool

pub const fn is_normal(self) -> bool

Not red 5

pub const fn is_red(self) -> bool

Red 5 (赤牌)

pub const fn has_red(self) -> bool

Either red or normal 5

pub const fn is_numeral(self) -> bool

Numerals (数牌) := Characters (萬子) + Dots (筒子) + Bamboos (索子)

pub const fn is_pure_terminal(self) -> bool

Pure terminals (老頭牌) := {1,9}{m,p,s}

pub const fn is_middle(self) -> bool

Middle numerals (中張牌) := {2..=8}{m,p,s}

pub const fn is_wind(self) -> bool

Winds (風牌) := {1,2,3,4}z (correspond to {E,S,W,N})

pub const fn is_dragon(self) -> bool

Dragons (三元牌) := {5,6,7}z (correspond to {blue, green, red} dragons).

pub const fn is_honor(self) -> bool

Honors (字牌) := Winds (風牌) + Dragons (三元牌)

pub const fn is_terminal(self) -> bool

Terminals (么九牌) := Pure terminals (老頭牌) + Honors (字牌)

pub const fn encoding(self) -> u8

pub const fn normal_encoding(self) -> u8

Encoding of this tile, except red 5 is converted to normal 5

pub const fn red_encoding(self) -> u8

Encoding of this tile, except normal 5 is converted to red 5

pub const fn to_normal(self) -> Self

Converts a red 5 to normal 5; otherwise no-op.

pub const fn to_red(self) -> Self

Converts normal 5 to red 5; otherwise no-op.

pub const fn wind(self) -> Option<Wind>

Converts to the corresponding wind (ESWN) if this is a wind tile.

pub const fn num(self) -> u8

Returns the “number” part of the shorthand

pub const fn normal_num(self) -> u8

Returns the “number” part of the shorthand, with reds converted to non-red (i.e. 0 => 5).

pub const fn suit(self) -> u8

Returns the “suit” part of the shorthand (0, 1, 2, 3 for m, p, s, z respectively)

pub const fn succ(self) -> Option<Self>

For numerals 1 to 8, returns 2 to 9 respectively. Otherwise None.

pub const fn succ2(self) -> Option<Self>

For numerals 1 to 7, returns 3 to 9 respectively. Otherwise None.

pub const fn pred(self) -> Option<Self>

For numerals 2 to 9, returns 1 to 8 respectively. Otherwise None.

pub const fn pred2(self) -> Option<Self>

For numerals 3 to 9, returns 1 to 7 respectively. Otherwise None.

pub const fn indicated_dora(self) -> Self

Given this tile as the dora-indicator (ドラ表示牌), returns the indicated dora tile (ドラ).

Ref:

• https://ja.wikipedia.org/wiki/%E3%83%89%E3%83%A9_(%E9%BA%BB%E9%9B%80)

impl Tile

pub fn suit_char(self) -> char

Returns the “suit” part of the shorthand (0, 1, 2, 3 for m, p, s, z respectively)

pub const fn as_str(self) -> &'static str

Returns the standard shorthand string of this tile.

pub const fn unicode(self) -> char

Returns the corresponding codepoint in the Unicode Mahjong Tiles section (1F000 ~ 1F02F)

NOTE: The ordering in Unicode is differerent from Japanese Riichi Mahjong conventions.

Trait Implementations

impl Clone for Tile

fn clone(&self) -> Tile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tile

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

Formats the value using the given formatter.

impl Default for Tile

fn default() -> Tile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Tile

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

Formats the value using the given formatter.

impl FromIterator<Tile> for TileMask34

fn from_iter<T: IntoIterator<Item = Tile>>(tiles: T) -> Self

Creates a value from an iterator.

impl FromIterator<Tile> for TileSet34

fn from_iter<T: IntoIterator<Item = Tile>>(tiles: T) -> Self

Creates a value from an iterator.

impl FromIterator<Tile> for TileSet37

fn from_iter<T: IntoIterator<Item = Tile>>(tiles: T) -> Self

Creates a value from an iterator.

impl FromStr for Tile

type Err = UnspecifiedError

The associated error which can be returned from parsing.

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

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

impl Index<Tile> for TileSet34

type Output = u8

The returned type after indexing.

fn index(&self, tile: Tile) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Tile> for TileSet37

type Output = u8

The returned type after indexing.

fn index(&self, tile: Tile) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Tile> for TileSet34

fn index_mut(&mut self, tile: Tile) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Tile> for TileSet37

fn index_mut(&mut self, tile: Tile) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Into<&str> for Tile

fn into(self) -> &'static str

Converts this type into the (usually inferred) input type.

impl Ord for Tile

fn cmp(&self, other: &Self) -> 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 Tile

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Tile

type Error = UnspecifiedError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Tile

impl Eq for Tile

impl StructuralPartialEq for Tile