Struct Deck 

pub struct Deck { /* private fields */ }

The Deck represents a deck of zero or more cards. A default deck is 52 playing cards. Internally the deck consists of two stacks consisting of dealt and undealt cards. The dealt stack receives cards as they are dealt from the undealt stack.

The deck may be reset() to return it to its original state. A deck may be shuffle()’d to randomize its order. Shuffling uses a Knuth shuffle.

A deck can contain more than one card with the same rank / suit combination although by default it does not.

A deck cannot have more cards added or removed to it once it is created.

Implementations

impl Deck

pub fn new() -> Deck

Creates a new Deck containing the standard set of 52 cards

Examples found in repository

examples/main.rs (line 4)

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 from_cards(cards: &[Card]) -> Deck

Creates a new Deck containing the specified cards

pub fn undealt_count(&self) -> usize

Returns the number of remaining undealt cards in the Deck

pub fn dealt_count(&self) -> usize

Returns the number of dealt cards in the Deck

pub fn count(&self) -> usize

Returns the number of cards, dealt or undealt, within the Deck

pub fn dealt_cards(&self) -> &[Card]

Returns the collection of dealt cards

pub fn top_card(&self) -> Option<Card>

Tells you the top card (very next to be drawn) in the undealt deck without dealing it.

pub fn bottom_card(&self) -> Option<Card>

Tells you the bottom card (very last to be drawn) in the undealt deck without dealing it.

pub fn deal_one(&mut self) -> Result<Card, &'static str>

Deals the card from the undealt pile. If there are no cards left, the function will return an error.

Examples found in repository

examples/main.rs (line 11)

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 deal(&mut self, numcards: usize) -> Vec<Card>

Deals one or more card from the undealt pile and returns them as an array.

pub fn deal_to_hand(&mut self, hand: &mut Hand, numcards: usize) -> usize

Deals one or more card straight to the Hand. Returns the number of cards dealt.

pub fn reset(&mut self)

Return the dealt cards back to the end of the undealt pile. Order is preserved according to the default order or the last shuffle.

Examples found in repository

examples/main.rs (line 19)

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 reset_shuffle(&mut self)

Resets and shuffles the deck

Trait Implementations

impl Cards for Deck

fn cards(&self) -> &[Card]

Return the cards as a slice

fn mut_cards(&mut self) -> &mut [Card]

Return the cards as a mutable slice

fn shuffle(&mut self)

Shuffle the cards into a random order

fn sort_suit_ascending_rank(&mut self)

Sort the cards by suit and then by rank (low to high)

fn sort_suit_descending_rank(&mut self)

Sorts the cards by suit and then by rank (high to low)

fn sort_descending_rank_suit(&mut self)

Sort the cards by rank (high to low) and then by suit

impl Clone for Deck

fn clone(&self) -> Deck

Returns a duplicate of the value.

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

Performs copy-assignment from source.