Enum poker::Suit

pub enum Suit {
    Clubs,
    Hearts,
    Spades,
    Diamonds,
}

An enumeration type for representing the four card suits.

Variants

Clubs

The suit of clubs.

Hearts

The suit of hearts.

Spades

The suit of spades.

Diamonds

The suit of diamonds.

Implementations

impl Suit

pub const fn as_pretty_char(self) -> char

Get a Unicode representation of the suit, suitable for printing.

Example

use poker::Suit;
assert_eq!(Suit::Hearts.as_pretty_char(), '♥',);
assert_eq!(Suit::Diamonds.as_pretty_char(), '♦');
assert_eq!(Suit::Clubs.as_pretty_char(), '♣');
assert_eq!(Suit::Spades.as_pretty_char(), '♠');

pub const fn as_char(self) -> char

Get a textual representation of the suit. The character returned is the same character expected when parsing a suit from strings.

Example

use poker::Suit;
assert_eq!(Suit::Diamonds.as_char(), 'd');
assert_eq!(Suit::Clubs.as_char(), 'c');
assert_eq!(Suit::Spades.as_char(), 's');
assert_eq!(Suit::Hearts.as_char(), 'h');

Trait Implementations

impl Clone for Suit

fn clone(&self) -> Suit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Suit

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

impl Hash for Suit

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Suit> for Suit

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

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

#[must_use]

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

This method tests for !=.

impl StructuralEq for Suit

impl StructuralPartialEq for Suit

impl TryFrom<char> for Suit

type Error = char

The type returned in the event of a conversion error.

fn try_from(value: char) -> Result<Self, Self::Error>

Performs the conversion.