Enum Suit

pub enum Suit {
    S = 0,
    H = 1,
    D = 2,
    C = 3,
}

Enum for Suits

Represents the four suits in a standard deck of playing cards. Suits are ordered Spades < Hearts < Diamonds < Clubs for consistent comparison. Each suit has a unique numeric value (0-3) and character representation.

Examples

use open_pql::{Suit, Suit::*};

let suit = S; // Spades
assert_eq!(suit.to_string(), "s");
assert_eq!(suit as u8, 0);

let parsed: Suit = "h".parse().unwrap();
assert_eq!(parsed, H);

Variants

S = 0

♠️ Spade

H = 1

♥️ Heart

D = 2

♦️ Diamond

C = 3

♣️ Club

Implementations

impl Suit

pub const ARR_ALL: [Self; 4]

All possible suits

pub const fn from_char(c: char) -> Option<Self>

Creates a suit from a character

Trait Implementations

impl Clone for Suit

fn clone(&self) -> Suit

Returns a duplicate 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 Display for Suit

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

Formats the value using the given formatter.

impl From<Suit> for Suit4

fn from(s: Suit) -> Self

Converts to this type from the input type.

impl From<Suit> for char

fn from(value: Suit) -> Self

Converts to this type from the input type.

impl<T> From<T> for Suit

where Card: From<T>,

fn from(v: T) -> Self

Converts to this type from the input type.

impl FromStr for Suit

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<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 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,

Restrict a value to a certain interval.

impl PartialEq for Suit

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

Tests for self and other values to be equal, and is used by ==.

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<char> for Suit

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Suit

impl Eq for Suit

impl StructuralPartialEq for Suit