Enum poker::EvalError

pub enum EvalError {
    CardsNotUnique(Vec<Card>),
    InvalidHandSize(usize),
}

An error that can be thrown when evaluating poker hands.

Examples

If a group of Cards to be evaluated does not contain a set of unique cards, EvalError::CardsNotUnique will be thrown, as shown below:

use poker::{cards, Evaluator, EvalError};
let eval = Evaluator::new();
// Two king of clubs instead of a royal flush!
let hand = cards!(
    Ten, Clubs;
    Jack, Clubs;
    Queen, Clubs;
    King, Clubs;
    King, Clubs
).to_vec();
let result = eval.evaluate(&hand);
assert_eq!(
    result,
    Err(EvalError::CardsNotUnique(hand.clone()))
);

A group of 5 or more cards can be evaulated for the combination that yields the best possible poker hand, but four of less cards cannot be evaluated. This will throw EvalError::InvalidHandSize:

use poker::{cards, Evaluator, EvalError};
let eval = Evaluator::new();
let four_cards = cards!(
    Two, Clubs;
    Ten, Hearts;
    Seven, Hearts;
    Eight, Spades;
).to_vec();
let result = eval.evaluate(&four_cards);
assert_eq!(
    result,
    Err(EvalError::InvalidHandSize(4)),
);

Variants

CardsNotUnique(Vec<Card>)

This variant is used when the cards to be evaluated are not all unique. This captures the entire original hand, and the duplicates are calculated when reporting in Display format.

InvalidHandSize(usize)

This variant is used when the cards to be evaluated total to 4 or less.

Trait Implementations

impl Clone for EvalError

fn clone(&self) -> EvalError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EvalError

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

Formats the value using the given formatter.

impl Display for EvalError

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

Formats the value using the given formatter.

impl Eq for EvalError

impl Error for EvalError

pub fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<EvalError> for EvalError

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

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

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

This method tests for !=.

impl StructuralEq for EvalError

impl StructuralPartialEq for EvalError