Struct poker::Eval

pub struct Eval(_);

The result of a successful poker hand evaluation. When printed in Display format, shows the proper, qualified name of the poker hand.

Example

use poker::{cards, Evaluator};
let hand = cards!("7c 8d 3s Ks 7h")
    .try_collect::<Vec<_>>()
    .expect("couldn't parse cards");
let eval = Evaluator::new();
let result = eval.evaluate(hand).expect("couldn't evaluate hand");
assert_eq!(result.to_string(), "Pair, sevens");
assert!(result.is_pair());

Implementations

impl Eval

pub const BEST: Self

The best possible poker hand, a royal flush.

pub const WORST: Self

The worst possible poker hand, a seven-high.

pub const fn class(self) -> EvalClass

The class of poker hand that was evaluated. Useful for pattern matching as opposed to checking with an is_x() method.

pub const fn is_high_card(self) -> bool

Check whether this hand is a high-card.

pub const fn is_pair(self) -> bool

Check whether this hand is a pair.

pub const fn is_two_pair(self) -> bool

Check whether this hand is a two-pair.

pub const fn is_three_of_a_kind(self) -> bool

Check whether this hand is a three-of-a-kind.

pub const fn is_straight(self) -> bool

Check whether this hand is a straight.

pub const fn is_flush(self) -> bool

Check whether this hand is a flush.

pub const fn is_full_house(self) -> bool

Check whether this hand is a full house.

pub const fn is_four_of_a_kind(self) -> bool

Check whether this hand is a four-of-a-kind.

pub const fn is_straight_flush(self) -> bool

Check whether this hand is a straight flush.

pub const fn is_royal_flush(self) -> bool

Check whether this hand is a royal flush.

Trait Implementations

impl Clone for Eval

fn clone(&self) -> Eval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Eval

impl Debug for Eval

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

Formats the value using the given formatter.

impl Display for Eval

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

Formats the value using the given formatter.

impl Eq for Eval

impl Hash for Eval

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Eval

fn cmp(&self, other: &Eval) -> 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<Eval> for Eval

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

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

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

This method tests for !=.

impl PartialOrd<Eval> for Eval

fn partial_cmp(&self, other: &Eval) -> 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 Eval

impl StructuralPartialEq for Eval