rummy 0.2.0

a crate for the card game Rummy
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

//! Contains the main `Game` trait, which encapsulates the overall behaviour expected of a Rummy game.
//!
//! A `Game` has an associated type `Rules: GameRules`, which mostly handles evaluating of game actions.
//!
//! This ensures a separation between game administration and action evaluations.

use super::action::*;
use crate::{
    cards::card::CardData,
    game::{
        error::{ActionError, GameError},
        rules::GameRules,
        state::GameState,
    },
};

/// Represents a Rummy game.
pub trait Game {
    /// The `GameRules` that this game follows.
    type Rules: GameRules;

    /// Attempt to execute the `GameAction` for the current player.
    ///
    /// Returns an `Err` if the action couldn't be executed for some reason.
    fn execute_action(&mut self, action: GameAction) -> Result<(), ActionError>;

    /// Inspect the game's current state.
    fn get_state(
        &self,
    ) -> &GameState<<<Self as Game>::Rules as GameRules>::VariantScore, Self::Rules>;

    /// Quit a player whose ID is `player_id`.
    ///
    /// Returns an `Err` if such player doesn't exist, or the game already ended.
    fn quit_player(&mut self, player_id: usize) -> Result<(), GameError>;

    /// Add a player using the given `player_id`.
    ///
    /// Returns an `Err` if the maximum number of players has been reached,
    /// or a player with that ID already exists.
    fn add_player(&mut self, player_id: usize) -> Result<(), GameError>;

    /// Rearranges the player's cards according to what is present in `new_arrangement`.
    ///
    /// Returns an `Err` if such player doesn't exist,
    /// `new_arrangement` doesn't contain the exact cards currently in that player's hand,
    /// or the game phase isn't `Draw` or `Play`.
    fn rearrange_player_hand(
        &mut self,
        player_id: usize,
        new_arrangement: Vec<CardData>,
    ) -> Result<(), GameError>;

    /// Calculate and store round scores and start the next round.
    ///
    /// Returns an `Err` if the game phase is not `RoundEnd`,
    /// or the setup failed for some reason.
    fn next_round(&mut self) -> Result<(), GameError>;
}