Struct Card

pub struct Card {
    pub rank: Rank,
    pub suit: Suit,
}

Single Card

Represents a single playing card with a rank and suit. Cards are ordered first by rank then by suit for consistent comparison.

Examples

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

let card = Card::new(RA, S);
assert_eq!(card.rank, RA);
assert_eq!(card.suit, S);
assert_eq!(card.to_string(), "As");

Fields

rank: Rank

suit: Suit

Implementations

impl Card

pub const ARR_ALL: [Self; 52]

Array of all 52 playing cards in a standard deck. Cards are ordered by rank (2-A) then by suit (S, H, D, C).

pub const ARR_ALL_SHORT: [Self; 36]

Array of 36 cards for short deck poker (6-A). Excludes ranks 2-5, commonly used in some poker variants.

pub const fn new(r: Rank, s: Suit) -> Self

Creates a new card with the specified rank and suit.

Examples

use open_pql::{Card, Rank, Suit};

let ace_spades = Card::new(Rank::RA, Suit::S);

Trait Implementations

impl Clone for Card

fn clone(&self) -> Card

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Card

Debug implementation for Card.

Uses the Display format for debug output.

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

Formats the value using the given formatter.

impl Default for Card

Default implementation for Card.

Returns the Two of Spades as the default card.

fn default() -> Self

Returns the “default value” for a type.

impl Display for Card

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

Formats the value using the given formatter.

impl From<Card> for Card64

fn from(c: Card) -> Self

Converts to this type from the input type.

impl From<Card> for VmStackValue

fn from(value: PQLCard) -> Self

Converts to this type from the input type.

impl FromStr for Card

FromStr implementation for Card.

Parses a card from string format like “As” (Ace of Spades). Whitespace is ignored during parsing.

Errors

Returns ParseError::InvalidCard if the string cannot be parsed as a valid card.

Examples

use open_pql::Card;

let card: Card = "As".parse().unwrap();
let card_with_spaces: Card = " A s ".parse().unwrap();

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 Card

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 Card

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

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

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

impl Eq for Card

impl StructuralPartialEq for Card