rsshogi 1.2.0

Reusable Rust shogi primitives for board state, move generation, legality, and record parsing.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use super::Color;

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
#[repr(u8)]
pub enum GameResult {
    BlackWin = 0,
    WhiteWin = 1,
    DrawByRepetition = 2,
    Error = 3,
    BlackWinByDeclaration = 4,
    WhiteWinByDeclaration = 5,
    DrawByMaxPlies = 6,
    #[default]
    Invalid = 7,
    BlackWinByForfeit = 8,
    WhiteWinByForfeit = 9,
    DrawByImpasse = 10,
    Paused = 11,
    BlackWinByIllegalMove = 12,
    WhiteWinByIllegalMove = 13,
    BlackWinByTimeout = 16,
    WhiteWinByTimeout = 17,
    BlackWinByTryRule = 20,
    WhiteWinByTryRule = 21,
}

impl GameResult {
    pub const fn is_black_win(self) -> bool {
        matches!(
            self,
            Self::BlackWin
                | Self::BlackWinByDeclaration
                | Self::BlackWinByForfeit
                | Self::BlackWinByIllegalMove
                | Self::BlackWinByTimeout
                | Self::BlackWinByTryRule
        )
    }
    pub const fn is_white_win(self) -> bool {
        matches!(
            self,
            Self::WhiteWin
                | Self::WhiteWinByDeclaration
                | Self::WhiteWinByForfeit
                | Self::WhiteWinByIllegalMove
                | Self::WhiteWinByTimeout
                | Self::WhiteWinByTryRule
        )
    }
    pub const fn is_draw(self) -> bool {
        matches!(self, Self::DrawByRepetition | Self::DrawByMaxPlies | Self::DrawByImpasse)
    }
    pub const fn is_win(self) -> bool {
        self.is_black_win() || self.is_white_win()
    }
    pub const fn is_win_by_declaration(self) -> bool {
        matches!(self, Self::BlackWinByDeclaration | Self::WhiteWinByDeclaration)
    }
    pub const fn is_win_by_try_rule(self) -> bool {
        matches!(self, Self::BlackWinByTryRule | Self::WhiteWinByTryRule)
    }
    pub const fn winner_color(self) -> Option<Color> {
        if self.is_black_win() {
            Some(Color::BLACK)
        } else if self.is_white_win() {
            Some(Color::WHITE)
        } else {
            None
        }
    }
    pub const fn to_score(self) -> i8 {
        if self.is_black_win() {
            1
        } else if self.is_white_win() {
            -1
        } else {
            0
        }
    }
    pub const fn win_from_color(color: Color) -> Self {
        match color {
            Color::BLACK => Self::BlackWin,
            Color::WHITE => Self::WhiteWin,
        }
    }
    pub const fn win_by_declaration_from_color(color: Color) -> Self {
        match color {
            Color::BLACK => Self::BlackWinByDeclaration,
            Color::WHITE => Self::WhiteWinByDeclaration,
        }
    }
    pub const fn win_by_forfeit_from_color(color: Color) -> Self {
        match color {
            Color::BLACK => Self::BlackWinByForfeit,
            Color::WHITE => Self::WhiteWinByForfeit,
        }
    }
    pub const fn win_by_illegal_move_from_color(color: Color) -> Self {
        match color {
            Color::BLACK => Self::BlackWinByIllegalMove,
            Color::WHITE => Self::WhiteWinByIllegalMove,
        }
    }
    pub const fn win_by_timeout_from_color(color: Color) -> Self {
        match color {
            Color::BLACK => Self::BlackWinByTimeout,
            Color::WHITE => Self::WhiteWinByTimeout,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::GameResult;

    #[test]
    fn result_raw_values_and_classification() {
        let raw_values = [
            (GameResult::BlackWin, 0),
            (GameResult::WhiteWin, 1),
            (GameResult::DrawByRepetition, 2),
            (GameResult::Error, 3),
            (GameResult::BlackWinByDeclaration, 4),
            (GameResult::WhiteWinByDeclaration, 5),
            (GameResult::DrawByMaxPlies, 6),
            (GameResult::Invalid, 7),
            (GameResult::BlackWinByForfeit, 8),
            (GameResult::WhiteWinByForfeit, 9),
            (GameResult::DrawByImpasse, 10),
            (GameResult::Paused, 11),
            (GameResult::BlackWinByIllegalMove, 12),
            (GameResult::WhiteWinByIllegalMove, 13),
            (GameResult::BlackWinByTimeout, 16),
            (GameResult::WhiteWinByTimeout, 17),
            (GameResult::BlackWinByTryRule, 20),
            (GameResult::WhiteWinByTryRule, 21),
        ];
        for (result, expected) in raw_values {
            assert_eq!(result as u8, expected);
        }
        assert_eq!(GameResult::WhiteWinByTryRule.to_score(), -1);
        assert!(GameResult::DrawByImpasse.is_draw());
        assert_eq!(GameResult::BlackWinByForfeit.winner_color(), Some(super::Color::BLACK));
    }
}