Enum onejoker::cards::rank::Rank

#[repr(u8)]
pub enum Rank {
    None = 0,
    LowAce = 1,
    Deuce = 2,
    Trey = 3,
    Four = 4,
    Five = 5,
    Six = 6,
    Seven = 7,
    Eight = 8,
    Nine = 9,
    Ten = 10,
    Jack = 11,
    Knight = 12,
    Queen = 13,
    King = 14,
    Ace = 15,
}

wiki | Simple numeric enum for card ranks

Simple integer enum. Specific numbers do matter: I do a lot of math with them to optimize things, and the same numbers are used in the other languages in the project.

Note that there are two slots for aces and a slot for knight/cavalier. See Ace and Knight @ wiki for details.

Variants

None = 0

LowAce = 1

Deuce = 2

Trey = 3

Four = 4

Five = 5

Six = 6

Seven = 7

Eight = 8

Nine = 9

Ten = 10

Jack = 11

Knight = 12

Queen = 13

King = 14

Ace = 15

Implementations

impl Rank

pub const fn from_u8(v: u8) -> Rank

Convert integer to rank

use onejoker::prelude::*;

assert_eq!(Rank::Deuce, Rank::from_u8(2));

pub const fn from_char(c: char) -> Rank

Convert character to rank

use onejoker::prelude::*;

assert_eq!(Rank::Trey, Rank::from_char('3'));

pub const fn to_char(&self) -> char

Convert to char

use onejoker::prelude::*;

assert_eq!('4', Rank::Four.to_char());

pub const fn name(&self) -> &str

Produce “seven”, “jack”, etc.

use onejoker::prelude::*;

assert_eq!("seven", Rank::Seven.name());

pub const fn plural(&self) -> &str

Because we have to deal with “sixes”

use onejoker::prelude::*;

assert_eq!("fives", Rank::Five.plural());
assert_eq!("sixes", Rank::Six.plural());

pub const fn article(&self) -> &str

Because we have to deal with “eight” and “ace”

use onejoker::prelude::*;

assert_eq!("an", Rank::Eight.article());
assert_eq!("a", Rank::Nine.article());

Trait Implementations

impl Clone for Rank

fn clone(&self) -> Rank

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rank

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

Formats the value using the given formatter.

impl Default for Rank

fn default() -> Rank

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rank

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Rank

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

Formats the value using the given formatter.

impl From<u32> for Rank

fn from(v: u32) -> Self

Converts to this type from the input type.

impl FromStr for Rank

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for Rank

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Rank

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Rank

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Rank

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Serialize for Rank

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Rank

impl Eq for Rank

impl StructuralPartialEq for Rank