Enum poker::EvalClass

pub enum EvalClass {
    HighCard {
        high_rank: Rank,
    },
    Pair {
        pair: Rank,
    },
    TwoPair {
        first_pair: Rank,
        second_pair: Rank,
    },
    ThreeOfAKind {
        trips: Rank,
    },
    Straight {
        high_rank: Rank,
    },
    Flush {
        high_rank: Rank,
    },
    FullHouse {
        trips: Rank,
        pair: Rank,
    },
    FourOfAKind {
        quads: Rank,
    },
    StraightFlush {
        high_rank: Rank,
    },
}

A utility enumeration type for pattern matching against the result of Eval::class. Each variant represents a class of poker hand. Royal flush is not included, but can be matched against EvalClass:StraightFlush { high_card: Rank::Ace } if desired.

Example

use poker::{cards, Evaluator, EvalClass, Rank};

let hand = cards!(
    Ace of Clubs,
    Two of Spades,
    Three of Diamonds,
    Four of Diamonds,
    Five of Clubs,
);
let eval = Evaluator::new();
let result = eval.evaluate(&hand).expect("couldn't evaluate hand");
assert!(matches!(result.class(), EvalClass::Straight { high_rank: Rank::Five }));

Variants

HighCard

A high card, or no hand.

Fields of HighCard

high_rank: Rank

The high card rank.

Pair

A pair, two cards of the same rank

Fields of Pair

pair: Rank

The ranks of the pair.

TwoPair

Two pair. two cards of the same rank and two other cards of the same but distinct rank

Fields of TwoPair

first_pair: Rank

The ranks of the first pair.

second_pair: Rank

The ranks of the second pair.

ThreeOfAKind

Three of a kind, three cards of the same rank. Sometimes called trips.

Fields of ThreeOfAKind

trips: Rank

The ranks of the trips.

Straight

A straight, five cards in rank order. Straights go from A2345 to TJQKA.

Fields of Straight

high_rank: Rank

The rank of the highest card in the straight.

Flush

A flush, five cards of the same suit.

Fields of Flush

high_rank: Rank

The rank of the highest card in the flush.

FullHouse

A full house, one pair and one three of a kind

Fields of FullHouse

trips: Rank

The rank of the trips of the full house.

pair: Rank

The rank of the pair of the full house.

FourOfAKind

Four of a kind, four cards of the same rank. Sometimes called quads.

Fields of FourOfAKind

quads: Rank

The rank of the quads.

StraightFlush

A straight flush, like a straight but all the cards are of the same suit.

Fields of StraightFlush

high_rank: Rank

The rank of the highest card in the straight flush.

Trait Implementations

impl Clone for EvalClass

fn clone(&self) -> EvalClass

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for EvalClass

impl Debug for EvalClass

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for EvalClass

impl Ord for EvalClass

fn cmp(&self, other: &EvalClass) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<EvalClass> for EvalClass

fn eq(&self, other: &EvalClass) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EvalClass) -> bool

This method tests for !=.

impl PartialOrd<EvalClass> for EvalClass

fn partial_cmp(&self, other: &EvalClass) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for EvalClass

impl StructuralPartialEq for EvalClass