Enum onejoker::cards::suit::Suit

#[repr(u8)]
pub enum Suit {
    None = 0,
    Club = 1,
    Diamond = 2,
    Heart = 3,
    Spade = 4,
}

wiki | A simple numeric enum for card suits

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.

Variants

None = 0

Joker, etc.

Club = 1

Clubs / Batons / Acorns / Wands

Diamond = 2

Diamonds / Coins / Bells / Pentacles

Heart = 3

Hearts / Cups / Roses

Spade = 4

Spades / Swords / Leaves / Shields

Implementations

impl Suit

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

Convert integer to suit

use onejoker::prelude::*;

assert_eq!(Suit::Club, Suit::from_u8(1));

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

Accept ASCII text or Unicode solid/black suit symbols U+2660, U+2665, U+2666, U+2663

use onejoker::prelude::*;

assert_eq!(Suit::Heart, Suit::from_char('h'));
assert_eq!(Suit::Club, Suit::from_char('♣'));

pub const fn to_char(&self) -> char

Produce the ASCII version

use onejoker::prelude::*;

assert_eq!('d', Suit::Diamond.to_char());

pub const fn to_symbol(&self) -> char

Produce the Unicode version

use onejoker::prelude::*;

assert_eq!('♠', Suit::Spade.to_symbol());

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

Produce “club”, “diamond”, etc.

use onejoker::prelude::*;

assert_eq!("diamond", Suit::Diamond.name());

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

Produce “hearts”, “spades”, etc.

Not really needed since there are no tricky ones like rank “six”, but other (human) languages may need it.

use onejoker::prelude::*;

assert_eq!("spades", Suit::Spade.plural());

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

Likewise, no tricks, but for consistency

use onejoker::prelude::*;

assert_eq!("a", Suit::Club.article());

Trait Implementations

impl Clone for Suit

fn clone(&self) -> Suit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Suit

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

Formats the value using the given formatter.

impl Default for Suit

fn default() -> Suit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Suit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Suit

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

Formats the value using the given formatter.

impl From<u32> for Suit

fn from(v: u32) -> Suit

Converts to this type from the input type.

impl FromStr for Suit

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 Suit

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 Suit

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

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

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

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 Suit

impl Eq for Suit

impl StructuralPartialEq for Suit