Struct Card 

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

A Card has a Rank and a Suit and represents a card from the normal 52-card playing deck.

Example

use deckofcards::{Card, Rank, Suit};
let card = Card::new(Rank::Jack, Suit::Hearts);

Fields

rank: Rank

The card’s Rank, e.g. Jack

suit: Suit

The card’s Suit, e.g. Hearts

Implementations

impl Card

pub fn new(rank: Rank, suit: Suit) -> Card

Creates a card with the given suit and rank

pub fn cmp_rank_then_suit(&self, other: &Card) -> Ordering

Compares by rank and then suit

pub fn cmp_desc_rank_then_suit(&self, other: &Card) -> Ordering

Compares by descending rank and then suit

pub fn cmp_suit_then_rank(&self, other: &Card) -> Ordering

Compares by suit and then rank

pub fn cmp_suit_then_desc_rank(&self, other: &Card) -> Ordering

Compares by suit and then rank

pub fn from_str(s: &str) -> Result<Card, &'static str>

Creates a card from a string such, e.g. “AS” returns Ace of Spades

pub fn to_str(&self) -> String

Turns the card into a short string consisting of rank, suit, e.g. “AS”

pub fn name(&self) -> String

Returns an English formatted name of the card, e.g. “Ace of Spades”

Examples found in repository

examples/main.rs (line 12)

fn main() {
    let mut deck = Deck::new();

    // Shuffle the deck
    deck.shuffle();

    // Deal a card
    for _ in 0..10 {
        if let Ok(card) = deck.deal_one() {
            println!("You dealt a {}", card.name());
        } else {
            panic!("We should have enough cards for this not to happen")
        }
    }

    // Put dealt cards back onto the deck
    deck.reset();
}

pub fn ordinal(&self) -> usize

Returns an ordinal for the card which is a unique number which can be used for indexing

pub fn is_hearts(&self) -> bool

Tests if the card is Hearts

pub fn is_clubs(&self) -> bool

Tests if the card is Clubs

pub fn is_spades(&self) -> bool

Tests if the card is Spades

pub fn is_diamonds(&self) -> bool

Tests if the card is Diamonds

pub fn all_cards() -> &'static [Card]

Returns an array slice containing all the cards in a standard 52-card deck

pub fn iterator() -> Iter<'static, Card>

Trait Implementations

impl AddAssign<Card> for Hand

fn add_assign(&mut self, rhs: Card)

Performs the += operation.

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

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

Formats the value using the given formatter.

impl Display for Card

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

Formats the value using the given formatter.

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

Sorts by rank and then suit

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