freecell 0.1.0

Game objects and rules for the solitaire card game FreeCell
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

use std::fmt::{Display, Formatter, Result};

/// Indicates the colour of a card.
///
/// The suits Club and Spade are black, whereas Heart and Diamond are red.
///
/// # Examples
///
/// ```
/// use freecell::{Card, Colour, Suit, ACE, KING};
///
/// let black_card = Card {suit: Suit::Spade, rank: ACE};
/// assert_eq!(Colour::Black, black_card.suit.colour());
///
/// let red_card = Card {suit: Suit::Heart, rank: KING};
/// assert_eq!(Colour::Red, red_card.suit.colour());
/// ```
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub enum Colour {
    Black,
    Red,
}

/// Alias for the American spelling of Colour.
pub type Color = Colour;

impl Display for Colour {
    fn fmt(&self, f: &mut Formatter) -> Result {
        match self {
            Colour::Black => write!(f, "black"),
            Colour::Red => write!(f, "red"),
        }
    }
}