Struct riichi_tools_rs::riichi::tile::Tile

pub struct Tile {
    pub tile_type: TileType,
    pub is_red: bool,
    pub is_open: bool,
    pub is_draw: bool,
    pub is_chi: bool,
    pub is_pon: bool,
    pub called_from: u8,
    pub is_kan: bool,
    pub is_riichi: bool,
    pub is_tsumogiri: bool,
    pub id_136: Option<u8>,
}

Fields

tile_type: TileType

is_red: bool

is_open: bool

is_draw: bool

is_chi: bool

is_pon: bool

called_from: u8

is_kan: bool

is_riichi: bool

is_tsumogiri: bool

id_136: Option<u8>

Implementations

impl Tile

pub fn new(tile_type: TileType) -> Tile

pub fn from_text(representation: &str) -> Result<Tile, RiichiError>

pub fn from_id(id: u8) -> Result<Tile, RiichiError>

id is an integer value > 0 of a tile. The order is Manzu - Pinzu - Souzu - Winds - Dragons

pub fn to_id(&self) -> u8

Gets the id of this tile based on its type

pub fn to_id_minus_1(&self) -> u8

Some algorithms use ids starting from 0

pub fn next_id(&self, dora: bool, depth: u8) -> u8

Returns an ID of the next tile in order.

pub fn prev_id(&self, dora: bool, depth: u8) -> u8

Returns an ID of the previous tile in order.

pub fn next(&self, dora: bool) -> Option<Tile>

1-8 returns the next number 9 returns None for dora = false, 1 for dora = true honors return None for dora = false, honor order for dora = true

pub fn prev(&self) -> Option<Tile>

pub fn is_terminal(&self) -> bool

pub fn is_honor(&self) -> bool

pub fn is_terminal_or_honor(&self) -> bool

pub fn get_type_char(&self) -> char

pub fn get_value(&self) -> u8

Trait Implementations

impl Clone for Tile

fn clone(&self) -> Tile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Tile

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 Display for Tile

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

Formats the value using the given formatter.

impl Eq for Tile

impl Ord for Tile

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Tile> for Tile

fn eq(&self, other: &Tile) -> bool

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

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Tile> for Tile

fn partial_cmp(&self, other: &Tile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method 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 as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.