Struct onejoker::cards::card::Card

pub struct Card(pub Ordinal);

wiki | A simple card object wrapping a u8

A simple new-type wrapper around the Ordinal value, which is just an alias for u8.

Tuple Fields

0: Ordinal

Implementations

impl Card

pub const fn from_i32(v: i32) -> Option<Card>

Create a new Card from an integer value

use onejoker::prelude::*;

let c = Card::from_i32(3).unwrap();
assert_eq!(c, JOKER);

pub const fn from_rank_suit(r: Rank, s: Suit) -> Card

Create a new Card from a Rank and a Suit

If the Rank and Suit objects are valid, this cannot fail, so it returns a real Card, not an Option.

use onejoker::prelude::*;

let c = Card::from_rank_suit(Rank::Ace, Suit::Spade);
assert_eq!(c, ACE_OF_SPADES);

pub const fn low_ace_fix(v: Card) -> Card

Ensure correct flavor of ace for low-ace decks

Return a card value unmolested, unless it’s a high ace, in which case return the low ace of the same suit.

use onejoker::prelude::*;

let c = Card::from_i32(63).unwrap();
assert_eq!(c, ACE_OF_SPADES);
assert_eq!(Card::low_ace_fix(c), LOW_ACE_OF_SPADES);

pub const fn high_ace_fix(v: Card) -> Card

Ensure correct flavor of ace for high-ace decks

Return a card value unmolested, unless it’s a low ace, in which case return the high ace of the same suit.

use onejoker::prelude::*;

let c = Card::from_i32(4).unwrap();
assert_eq!(c, LOW_ACE_OF_CLUBS);
assert_eq!(Card::high_ace_fix(c), ACE_OF_CLUBS);

pub const fn rank(&self) -> Rank

Rank of the card, if any.

Rank is Rank::None for jokers or illegal values

use onejoker::prelude::*;

assert_eq!(Rank::Deuce, DEUCE_OF_CLUBS.rank());
assert_eq!(Rank::None, BLACK_JOKER.rank());

pub const fn suit(&self) -> Suit

Suit of the card if any.

Suit is Suit::None for jokers or illegal values.

use onejoker::prelude::*;

assert_eq!(Suit::Club, TREY_OF_CLUBS.suit());
assert_eq!(Suit::None, JOKER.suit());

pub const fn is_card(&self) -> bool

Does the object represent an actual card, and not an illegal value?

use onejoker::prelude::*;

assert!(ACE_OF_SPADES.is_card());
assert!(JOKER.is_card());
assert!(! Card(0).is_card());

pub const fn is_red(&self) -> bool

Is the card a diamond, heart, or red/colored joker?

use onejoker::prelude::*;

assert!(ACE_OF_DIAMONDS.is_red());
assert!(JOKER.is_red());    // Yes, jokers have no suit, but are red/black
assert!(! KING_OF_SPADES.is_red());

pub const fn is_black(&self) -> bool

Is the card a club, spade, or black joker?

use onejoker::prelude::*;

assert!(ACE_OF_CLUBS.is_black());
assert!(BLACK_JOKER.is_black());
assert!(! QUEEN_OF_DIAMONDS.is_black());

pub const fn is_joker(&self) -> bool

Is the card any kind of joker?

use onejoker::prelude::*;

assert!(JOKER.is_joker());
assert!(BLACK_JOKER.is_joker());
assert!(WHITE_JOKER.is_joker());
assert!(! ACE_OF_CLUBS.is_joker());

pub const fn is_ace(&self) -> bool

Is the card an ace (high or low)?

use onejoker::prelude::*;

assert!(ACE_OF_CLUBS.is_ace());
assert!(LOW_ACE_OF_DIAMONDS.is_ace());
assert!(! QUEEN_OF_HEARTS.is_ace());

pub const fn is_club(&self) -> bool

Is the card suit $x?

pub const fn is_diamond(&self) -> bool

Is the card suit $x?

pub const fn is_heart(&self) -> bool

Is the card suit $x?

pub const fn is_spade(&self) -> bool

Is the card suit $x?

pub const fn is_deuce(&self) -> bool

Is the card rank $x?

pub const fn is_trey(&self) -> bool

Is the card rank $x?

pub const fn is_four(&self) -> bool

Is the card rank $x?

pub const fn is_five(&self) -> bool

Is the card rank $x?

pub const fn is_six(&self) -> bool

Is the card rank $x?

pub const fn is_seven(&self) -> bool

Is the card rank $x?

pub const fn is_eight(&self) -> bool

Is the card rank $x?

pub const fn is_nine(&self) -> bool

Is the card rank $x?

pub const fn is_ten(&self) -> bool

Is the card rank $x?

pub const fn is_jack(&self) -> bool

Is the card rank $x?

pub const fn is_knight(&self) -> bool

Is the card rank $x?

pub const fn is_queen(&self) -> bool

Is the card rank $x?

pub const fn is_king(&self) -> bool

Is the card rank $x?

pub fn to_unicode(&self) -> String

Produce text output with Unicode suit symbol

use onejoker::prelude::*;

assert_eq!(ACE_OF_SPADES.to_unicode(), "A♠");
assert_eq!(JOKER.to_unicode(), "Jk");

pub fn to_unicode_single(&self) -> String

Produce the single-character Unicode version of this card

Unicode code points (U+1F0A1..U+1F0DF) represent whole playing cards.

use onejoker::prelude::*;

assert_eq!(ACE_OF_SPADES.to_unicode_single(), "🂡")

pub fn full_name(&self) -> String

Full English name of card, e.g. “ace of spades”

use onejoker::prelude::*;

assert_eq!(JACK_OF_DIAMONDS.full_name(), "jack of diamonds");
assert_eq!(JOKER.full_name(), "joker");

pub const fn from_const_str(st: &str) -> Card

Const function to create a Card from a string literal

use onejoker::prelude::*;

assert_eq!(ACE_OF_CLUBS, Card::from_const_str("Ac"));
assert_eq!(JOKER, Card::from_const_str("Jk"));

Trait Implementations

impl Clone for Card

fn clone(&self) -> Card

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Card

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

Formats the value using the given formatter.

impl Default for Card

fn default() -> Card

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Card

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Card

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

Formats the value using the given formatter.

impl FromStr for Card

type Err = Error

The associated error which can be returned from parsing.

fn from_str(st: &str) -> Result<Self>

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Card

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

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 Card

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 Card

impl Eq for Card

impl StructuralPartialEq for Card