poker 0.7.0

A crate for speedy poker hand evaluation
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
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

use std::{
    convert::TryFrom,
    fmt::{self, Write},
};

/// An enumeration type for representing the four card suits.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum Suit {
    /// The suit of clubs.
    Clubs,
    /// The suit of hearts.
    Hearts,
    /// The suit of spades.
    Spades,
    /// The suit of diamonds.
    Diamonds,
}

impl Suit {
    pub(crate) const ALL_VARIANTS: &[Self] =
        &[Self::Clubs, Self::Hearts, Self::Spades, Self::Diamonds];

    /// Get a Unicode representation of the suit, suitable for printing.
    ///
    /// # Example
    ///
    /// ```
    /// use poker::Suit;
    /// assert_eq!(Suit::Hearts.as_pretty_char(), '♥',);
    /// assert_eq!(Suit::Diamonds.as_pretty_char(), '♦');
    /// assert_eq!(Suit::Clubs.as_pretty_char(), '♣');
    /// assert_eq!(Suit::Spades.as_pretty_char(), '♠');
    /// ```
    pub const fn as_pretty_char(self) -> char {
        use Suit::*;
        match self {
            Spades => '\u{2660}',   // ♠
            Hearts => '\u{2665}',   // ♥
            Clubs => '\u{2663}',    // ♣
            Diamonds => '\u{2666}', // ♦
        }
    }

    /// Get a textual representation of the suit. The character returned is the
    /// same character expected when parsing a suit from strings.
    ///
    /// # Example
    ///
    /// ```
    /// use poker::Suit;
    /// assert_eq!(Suit::Diamonds.as_char(), 'd');
    /// assert_eq!(Suit::Clubs.as_char(), 'c');
    /// assert_eq!(Suit::Spades.as_char(), 's');
    /// assert_eq!(Suit::Hearts.as_char(), 'h');
    /// ```
    pub const fn as_char(self) -> char {
        use Suit::*;
        match self {
            Clubs => 'c',
            Hearts => 'h',
            Spades => 's',
            Diamonds => 'd',
        }
    }

    /// Get the integer representation of the suit, where:
    /// - 0b0001 <== spades
    /// - 0b0010 <== hearts,
    /// - 0b0100 <== diamonds,
    /// - 0b1000 <== clubs
    pub(super) const fn as_i32(self) -> i32 {
        use Suit::*;
        match self {
            Clubs => 8,
            Hearts => 2,
            Spades => 1,
            Diamonds => 4,
        }
    }

    /// Create a suit from its integer representation. As this function is
    /// private, be sure to only pass in 1, 2, 4, or 8 to prevent the
    /// fallthrough case from executing.
    pub(super) const fn from_i32(val: i32) -> Self {
        use Suit::*;
        match val {
            0b1000 => Clubs,
            0b0100 => Diamonds,
            0b0010 => Hearts,
            0b0001 => Spades,
            _ => unreachable!(),
        }
    }
}

impl TryFrom<char> for Suit {
    type Error = char;

    fn try_from(value: char) -> Result<Self, Self::Error> {
        use Suit::*;
        match value {
            's' => Ok(Spades),
            'c' => Ok(Clubs),
            'h' => Ok(Hearts),
            'd' => Ok(Diamonds),
            x => Err(x),
        }
    }
}

impl fmt::Display for Suit {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_char(self.as_pretty_char()) }
}