pkr 0.1.0

A library for evaluating poker hands
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

use std::error::Error;

use strum_macros::EnumIter;

/// Represents the suit of a playing card in a standard 52-card deck.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, EnumIter)]
pub enum Suit {
    Club,
    Diamond,
    Heart,
    Spade,
}

impl Suit {
    /// Creates a new `Suit` from a string.
    ///
    /// # Arguments
    ///
    /// * `s` - A string slice that holds the suit identifier.
    ///
    /// # Examples
    ///
    /// ```
    /// use pkr::card::Suit;
    ///
    /// let s = Suit::new_from_str("h").unwrap();
    /// assert_eq!(s, Suit::Heart);
    /// ```
    ///
    /// # Errors
    ///
    /// Returns an `Box<dyn Error>` if the string does not match
    /// any suit.
    pub fn new_from_str(s: &str) -> Result<Self, Box<dyn Error>> {
        match s {
            "h" => Ok(Suit::Heart),
            "d" => Ok(Suit::Diamond),
            "c" => Ok(Suit::Club),
            "s" => Ok(Suit::Spade),
            _ => Err("Invalid suit identifier".into()),
        }
    }

    /// Creates a new instance of `Suit` from a numerical value.
    ///
    /// # Arguments
    ///
    /// * `num` - A usize representing a numerical value for a Suit.
    ///
    /// # Returns
    ///
    /// Returns an instance of `Result<Suit, Box<dyn Error>>`.
    /// If `num` does not match any Suit, an error is returned.
    pub fn new_from_num(num: usize) -> Result<Self, Box<dyn Error>> {
        match num {
            0 => Ok(Suit::Club),
            1 => Ok(Suit::Diamond),
            2 => Ok(Suit::Heart),
            3 => Ok(Suit::Spade),
            _ => Err(format!("Invalid numerical value for Suit: {}", num).into()),
        }
    }

    /// Returns a string slice representing the `Suit`.
    ///
    /// # Examples
    ///
    /// ```
    /// use crate::pkr::card::Suit;
    ///
    /// let suit = Suit::Heart;
    /// assert_eq!(suit.as_str(), "h");
    ///
    /// let suit = Suit::Diamond;
    /// assert_eq!(suit.as_str(), "d");
    /// ```
    pub fn as_str(&self) -> &'static str {
        match self {
            Suit::Heart => "h",
            Suit::Diamond => "d",
            Suit::Club => "c",
            Suit::Spade => "s",
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn valid_suit_from_string() {
        assert_eq!(Suit::new_from_str("h").unwrap(), Suit::Heart);
        assert_eq!(Suit::new_from_str("d").unwrap(), Suit::Diamond);
        assert_eq!(Suit::new_from_str("c").unwrap(), Suit::Club);
        assert_eq!(Suit::new_from_str("s").unwrap(), Suit::Spade);
    }

    #[test]
    fn invalid_suit_from_str() {
        assert!(Suit::new_from_str("x").is_err());
    }
}