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 `Player`, which is just a player in a Rummy game.
//!
//! Each player can be identified with a `usize` ID, obtainable by calling `id()`.
//! This ID is independent of the player's index within the game's players.

use super::cards::{card::Card, meld::Meld};

/// A Rummy player.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Player {
    /// How they're identified.
    pub(crate) id: usize,
    /// Their hand.
    pub(crate) cards: Vec<Card>,
    /// Their melds.
    pub(crate) melds: Vec<Meld>,
    /// Whether they're currently playing.
    pub(crate) active: bool,
    /// The round they joined in.
    pub(crate) joined_in_round: usize,
}

impl Player {
    /// Creates a new player.
    pub(crate) fn new(id: usize, active: bool, joined_in_round: usize) -> Self {
        Player {
            id,
            cards: Vec::new(),
            melds: Vec::new(),
            active,
            joined_in_round,
        }
    }

    /// Get the player's ID.
    pub fn id(&self) -> usize {
        self.id
    }

    /// Get the player's cards.
    pub fn cards(&self) -> &Vec<Card> {
        &self.cards
    }

    /// Get the player's melds.
    pub fn melds(&self) -> &Vec<Meld> {
        &self.melds
    }

    /// Whether the player is currently active.
    pub fn active(&self) -> bool {
        self.active
    }

    /// Which round the player joined in.
    pub fn joined_in_round(&self) -> usize {
        self.joined_in_round
    }
}