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

//! Contains the configuration for a [`BasicRummyGame`](super::game::BasicRummyGame).

/// Holds override configuration values for basic Rummy.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct BasicConfig {
    /// Overrides the default number of cards to deal at the start of each round.
    pub deal_amount: Option<usize>,
    /// Overrides the default number of cards a player draws from the deck.
    pub draw_deck_amount: Option<usize>,
    /// Overrides the default number of cards a player draws from the discard pile.
    pub draw_discard_pile_amount: Option<DrawDiscardPileOverride>,
}

/// The type of discard pile draw behaviour.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum DrawDiscardPileOverride {
    /// The player can choose how many cards they wish to draw from the discard pile.
    PlayerChooses,
    /// The player must draw the whole discard pile.
    WholePile,
    /// The player always draws this number of cards from the discard pile.
    Constant(usize),
}