Enum rs_poker::core::Value

pub enum Value {
    Two,
    Three,
    Four,
    Five,
    Six,
    Seven,
    Eight,
    Nine,
    Ten,
    Jack,
    Queen,
    King,
    Ace,
}

Card rank or value. This is basically the face value - 2

Variants

Two

2

Three

3

Four

4

Five

5

Six

6

Seven

7

Eight

8

Nine

9

Ten

T

Jack

J

Queen

Q

King

K

Ace

A

Methods

impl Value

#[must_use] pub fn from_u8(v: u8) -> Self

Take a u32 and convert it to a value.

Examples

use rs_poker::core::Value;
assert_eq!(Value::Four, Value::from_u8(Value::Four as u8));

#[must_use] pub fn values() -> [Self; 13]

Get all of the Value's that are possible. This is used to iterate through all possible values when creating a new deck, or generating all possible starting hands.

#[must_use] pub fn from_char(c: char) -> Option<Self>

Given a character parse that char into a value. Case is ignored as long as the char is in the ascii range (It should be). @returns None if there's no value there.

Examples

use rs_poker::core::Value;

assert_eq!(Value::Ace, Value::from_char('A').unwrap());

#[must_use] pub fn to_char(self) -> char

Convert this Value to a char.

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

How card ranks seperate the two values.

Examples

use rs_poker::core::Value;
assert_eq!(1, Value::Ace.gap(Value::King));

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Value

impl Eq for Value

impl Ord for Value

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Value> for Value

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

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

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

This method tests for !=.

impl PartialOrd<Value> for Value

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

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

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

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Debug for Value

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

Formats the value using the given formatter.

impl Hash for Value

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl StructuralPartialEq for Value

impl StructuralEq for Value