Enum onejoker::cards::suit::Suit

pub enum Suit {
    None = 0,
    Club = 1,
    Diamond = 2,
    Heart = 3,
    Spade = 4,
}

wiki | 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.

Variants

None = 0

Not valid suit, only used internally for special cases.

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_i32_const(v: i32) -> Option<Suit>

Convert integer to suit.

pub fn from_i32(v: i32) -> aResult<Suit>

Convert integer to suit.

pub fn from_char(c: char) -> aResult<Suit>

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

pub fn to_char(&self) -> char

Produce the ASCII version.

pub fn to_symbol(&self) -> char

Produce the Unicode version.

pub fn name(&self) -> &str

Produce “club”, “diamond”, etc.

pub fn plural(&self) -> &str

Produce “hearts”, “spades”, etc. Not really needed since there are no tricky ones like rank “six”, but other languages may need it.

pub fn article(&self) -> &str

Likewise, no tricks, but for consistency.

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 Display for Suit

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

Formats the value using the given formatter.

impl FromStr for Suit

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> aResult<Self, Self::Err>

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 Into<char> for Suit

fn into(self) -> char

Converts this type into the (usually inferred) input type.

impl Into<i32> for Suit

fn into(self) -> i32

Converts this type into the (usually inferred) input type.

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 Copy for Suit

impl Eq for Suit

impl StructuralPartialEq for Suit