riichi 0.1.0

Japanese Riichi Mahjong game engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use std::fmt::{Display, Formatter};

use riichi_elements::prelude::*;

/// A discarded tile with extra info.
///
/// This is both an [Action] and an entry in a player's discard stream (see [State]).
/// See `called_by` for the difference between the two usages.
///
/// ## Optional `serde` support
///
/// Straightforward struct mapping of all fields _with name remapping_.
///
/// Note that [Action] will take over the serde format if part of it, so this impl is only for
/// the discard stream in [State].
///
/// [Action]: super::Action
/// [State]: super::State
///
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Discard {
    /// The discarded tile.
    pub tile: Tile,

    /// If called by another player, that player; otherwise the player who discarded this tile.
    /// This is ignored if the `Discard` is nested in [`super::Action::Discard`].
    pub called_by: Player,

    /// Whether this tile was discarded as a part of declaring Riichi (立直, リーチ).
    #[cfg_attr(feature = "serde", serde(rename = "riichi"))]
    pub declares_riichi: bool,

    /// Whether this tile was discarded immediately after being drawn (ツモ切り).
    #[cfg_attr(feature = "serde", serde(rename = "tsumogiri"))]
    pub is_tsumogiri: bool,
}

impl Display for Discard {
    // NOTE: we won't be showing `called_by` here; most of the time it's redundant
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        if self.declares_riichi {
            write!(f, "RIICHI!({}{})",
                   self.tile,
                   if self.is_tsumogiri { "*" } else { " " })
        } else {
            write!(f, "discard({}{})",
                   self.tile,
                   if self.is_tsumogiri { "*" } else { " " })
        }
    }
}