Struct onejoker::cards::deck::Deck

pub struct Deck {
    pub master: &'static MasterDeck,
    pub cards: Vec<Card>,
}

wiki | “Live” deck of cards for play. An array of Card objects with methods appropriate for a deck of cards. Note that cards are pop()’d from end of the array for speed, making that notionally the “top” of the deck. We show the Deck reversed when printing for this reason to bake debugging easier. Cards in the deck are not accessed randomly by index, though they can be removed by value.

Fields

master: &'static MasterDeck

Static pointer to associated MasterDeck

cards: Vec<Card>

Current contents of the deck

Implementations

impl Deck

pub fn new(dname: &str) -> Deck

Create a new deck from a MasterDeck by name. Filled but not shuffled.

pub fn new_hand(&self) -> Hand

Create a new Hand associated with the same MasterDeck, and deal it some initial cards.

pub fn new_hand_with(&mut self, n: usize) -> Hand

Create a new Hand associated with the same MasterDeck, and deal it some initial cards.

pub fn to_vec(&self) -> Vec<Card>

Export the current contents of the deck as a vector of Card.

pub fn deal_to(&mut self, h: &mut Hand, n: usize) -> bool

Deal n cards from the deck to the given Hand.

pub fn valid_card(&self, card: Card) -> Option<Card>

Validate that the give card is legal for this deck, or panic if not.

pub fn refill(&mut self)

Refill the deck from the master list.

pub fn len(&self) -> usize

Return the number of cards remaining in the deck.

pub fn remaining(&self) -> usize

Alias for len().

pub fn size(&self) -> usize

Return the total number of cards in the full deck.

pub fn is_empty(&self) -> bool

Is the deck empty?

pub fn is_not_empty(&self) -> bool

Is the deck not empty?

pub fn contains(&self, card: Card) -> bool

Does the deck contain the given Card?

pub fn push(&mut self, card: Card)

Push a Card onto the deck. We do not generally expects cards to go in this direction, but it is useful for testing and simulation.

pub fn pop(&mut self) -> Option<Card>

Pop a Card from the deck. Return None if the deck is empty.

pub fn push_n<I>(&mut self, n: usize, cards: I)

where I: IntoIterator<Item = Card>,

Push a collection of Cards onto the deck.

pub fn pop_n(&mut self, n: usize) -> impl Iterator<Item = Card>

Pop n cards from the deck as an iterator.

pub fn remove_card(&mut self, card: Card) -> bool

Remove a card from the deck by value. Return true if found.

pub fn shuffle(&mut self)

Shuffle the deck in place.

pub fn sort(&mut self)

Sort the deck in place. This uses the same sort as the Hand class, so it’s technically descending by rank, but recall that Decks are printed in reverse, so it will look ascending.

pub fn combinations(&self, k: usize) -> impl Iterator<Item = Hand>

Iterate

impl Deck

pub fn iter(&self) -> CardIter

Create a new iterator over the deck.

Trait Implementations

impl Clone for Deck

fn clone(&self) -> Deck

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Deck

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

Formats the value using the given formatter.

impl Default for Deck

fn default() -> Self

Returns the “default value” for a type.

impl Display for Deck

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

Formats the value using the given formatter.

impl FromStr for Deck

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> aResult<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a> IntoIterator for &'a Deck

type Item = Card

The type of the elements being iterated over.

type IntoIter = CardIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> CardIter

Creates an iterator from a value.

impl IntoIterator for Deck

type Item = Card

The type of the elements being iterated over.

type IntoIter = CardIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> CardIntoIter

Creates an iterator from a value.