Struct Hand

pub struct Hand {
    pub cards: Vec<Card>,
}

A Hand is zero or more cards that represents some aspect of a game, e.g. the cards a person is holding. A hand may be shuffled or sorted and there are functions for adding or removing cards. Unlike a Deck, there is no concept of dealt or undealt cards.

Fields

cards: Vec<Card>

Implementations

impl Hand

pub fn new() -> Self

Create an empty hand

pub fn from_hand(hand: &Hand) -> Hand

Makes a Hand from an existing hand

pub fn from_cards(cards: &[Card]) -> Hand

Makes a Hand from a slice

pub fn from_strings(card_slice: &[&str]) -> Hand

Constructs a Hand from a slice of strings with abbreviated card rank / suit values

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

Adds one Card to the Hand

pub fn push_cards(&mut self, cards: &[Card])

Adds zero or more cards to the Hand

pub fn push_hand(&mut self, other: &Hand)

Adds zero or more cards from some other Hand

pub fn len(&self) -> usize

Returns the number of cards

pub fn clear(&mut self)

Clears the Hand (makes it empty)

pub fn remove(&mut self, index: usize) -> Card

Removes a Card from the Hand and returns it, panics if index does not exist

pub fn remove_cards(&mut self, cards: &[Card])

Removes the first instance of every matching card from the Hand

pub fn remove_all_cards(&mut self, cards: &[Card])

Removes the every instance of every matching card from the Hand

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

Removes first instance of the matching card from the Hand

pub fn cards_of_rank(&self, rank: Rank) -> Vec<Card>

Returns cards of the specified Rank

pub fn cards_of_suit(&self, suit: Suit) -> Vec<Card>

Returns cards of the specified Suit

Trait Implementations

impl<'a> AddAssign<&'a Hand> for Hand

fn add_assign(&mut self, rhs: &Hand)

Performs the += operation.

impl AddAssign<Card> for Hand

fn add_assign(&mut self, rhs: Card)

Performs the += operation.

impl Cards for Hand

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 Hand

fn clone(&self) -> Hand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Hand

fn default() -> Self

Returns the “default value” for a type.

impl Display for Hand

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

Formats the value using the given formatter.