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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
use rand::{seq::SliceRandom, thread_rng};
use std::cmp::Ordering;

/// Provides a rank (value)
///
/// Examples:
///
/// ```
/// use ionic_deckhandler::{Card, Suit, Rank};
///
/// let card = Card::new(Rank::Five, Suit::Hearts);
/// let ucard_rank = Card::get_rank(&card) as usize;
/// ```
///
/// ```
/// use ionic_deckhandler::{Card, Suit, Rank};
///
/// let mut hand_arr = [
///     Card::new(Rank::Five, Suit::Hearts),
///     Card::new(Rank::Three, Suit::Hearts),
///     Card::new(Rank::Two, Suit::Hearts),
///     Card::new(Rank::Ace, Suit::Hearts),
///     Card::new(Rank::Four, Suit::Hearts),
///     ];
/// ```
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum Rank {
    Ace,
    Two,
    Three,
    Four,
    Five,
    Six,
    Seven,
    Eight,
    Nine,
    Ten,
    Jack,
    Queen,
    King,
}

/// The total number of ranks within the deck of cards
pub const CARD_RANK_COUNT: usize = 13;

pub const ALL_RANKS: [Rank; CARD_RANK_COUNT] = [
    Rank::Ace,
    Rank::Two,
    Rank::Three,
    Rank::Four,
    Rank::Five,
    Rank::Six,
    Rank::Seven,
    Rank::Eight,
    Rank::Nine,
    Rank::Ten,
    Rank::Jack,
    Rank::Queen,
    Rank::King,
];

/// Provides a card suit
///
/// Examples:
///
/// ```
/// use ionic_deckhandler::{Card, Suit, Rank};
///
/// let card = Card::new(Rank::Five, Suit::Hearts);
/// let ucard_suit = Card::get_suit(&card) as usize;
/// ```
///
/// ```
/// use ionic_deckhandler::{Card, Suit, Rank};
///
/// let mut hand_arr = [
///     Card::new(Rank::Five, Suit::Hearts),
///     Card::new(Rank::Three, Suit::Hearts),
///     Card::new(Rank::Two, Suit::Hearts),
///     Card::new(Rank::Ace, Suit::Hearts),
///     Card::new(Rank::Four, Suit::Hearts),
///     ];
/// ```
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum Suit {
    Clubs,
    Diamonds,
    Hearts,
    Spades,
}

pub const ALL_SUITS: [Suit; 4] = [Suit::Clubs, Suit::Diamonds, Suit::Hearts, Suit::Spades];

/// A card containing a rank (card value) and a suit. A card may be compared
/// by value against other cards.
///
/// Examples:
///
/// ```
/// use ionic_deckhandler::{Card, Suit, Rank};
///
/// let mut hand_arr = [
///     Card::new(Rank::Five, Suit::Hearts),
///     Card::new(Rank::Three, Suit::Hearts),
///     Card::new(Rank::Two, Suit::Hearts),
///     Card::new(Rank::Ace, Suit::Hearts),
///     Card::new(Rank::Four, Suit::Hearts),
///     ];
///
/// hand_arr.sort();
/// ```
///
#[derive(Debug, Copy, Clone)]
pub struct Card {
    pub rank: Rank,
    pub suit: Suit,
}

impl Card {
    pub fn new(rank: Rank, suit: Suit) -> Self {
        Card { rank, suit }
    }

    pub fn get_deck() -> Vec<Self> {
        let mut deck = Vec::new();
        for suit in ALL_SUITS.iter() {
            for rank in ALL_RANKS.iter() {
                deck.push(Card::new(*rank, *suit));
            }
        }
        deck
    }

    pub fn get_suit(&self) -> Suit {
        self.suit
    }

    pub fn get_rank(&self) -> Rank {
        self.rank
    }
}

impl Ord for Card {
    fn cmp(&self, other: &Self) -> Ordering {
        self.rank.cmp(&other.rank)
    }
}

impl PartialOrd for Card {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Eq for Card {}

impl PartialEq for Card {
    fn eq(&self, other: &Self) -> bool {
        self.rank == other.rank
    }
}

/// A deck may be shuffled and sorted
///
/// Example:
///
/// ```
/// use ionic_deckhandler::{Card, Deck};
///
/// let mut deck = Card::get_deck();
/// {
///     let first_card = &deck[0];
///     assert_eq!(
///         format!("{:?}", first_card.get_suit()),
///         String::from("Clubs")
///     );
/// }
/// deck.shuffle_deck();
///
/// for card in deck.iter() {
///     println!("{:?}", card);
/// }
/// deck.sort();
/// for card in deck.iter() {
///     println!("{:?}", card);
/// }
/// ```
pub trait Deck {
    fn shuffle_deck(&mut self);

    fn take_from_top(&mut self) -> Option<Card>;

    fn push_to_bottom(&mut self, card: Card);
}

impl Deck for Vec<Card> {
    fn shuffle_deck(&mut self) {
        self.shuffle(&mut thread_rng())
    }

    fn take_from_top(&mut self) -> Option<Card> {
        self.pop()
    }

    fn push_to_bottom(&mut self, card: Card) {
        let len = self.len();
        self.insert(len, card);
    }
}