Struct onejoker::cards::hand::Hand

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

wiki | Hand of cards A simple array of card objects with some utility methods. It is expected that most access will go through push/pop``, which are fast, though things line insertandremove` are available.

Fields

master: &'static MasterDeck

Associated MasterDeck

cards: Vec<Card>

Current contents

Implementations

impl Hand

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

Create new Hand associated with the named MasterDeck.

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

Create a new Hand associated with the default MasterDeck containing the cards given in the iterator.

pub fn from_text(text: &str) -> Hand

Create a new Hand associated with the default MasterDeck containing the hand given in text form.

pub fn copy_from_slice(&self, cards: &[Card]) -> Hand

Create a new “sister” Hand with the Cards given as a slice.

pub fn copy_from_text(&self, text: &str) -> Hand

Create a new “sister” Hand with the Cards given as text.

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

Export Vec of Cards.

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

Point to a slice of the underlying Card array.

pub fn len(&self) -> usize

How many cards in the hand?

pub fn is_empty(&self) -> bool

Is the hand empty?

pub fn is_not_empty(&self) -> bool

Is the hand not empty?

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

Does the hand contain the given Card?

pub fn clear(&mut self)

Empty the hand

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

Given a Card, return the same card if valid for our MasterDeck or panic. Correct ace values if needed.

pub fn card_at(&self, index: usize) -> Option<Card>

Return the Card at the given index, or None if out of range.

pub fn set_card_at(&mut self, index: usize, card: Card) -> bool

Set the Card at the given index, or return false if out of range.

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

Push a Card onto the end of the hand.

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

Pop a Card from the end of the hand.

pub fn push_n<I>(&mut self, n: usize, iter: I) -> bool

where I: IntoIterator<Item = Card>,

Push a collection of Cards onto the end of the hand.

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

Pop n Cards from the end of the hand.

pub fn insert_at(&mut self, index: usize, card: Card) -> bool

Insert a Card at the given index.

pub fn remove_at(&mut self, index: usize) -> Option<Card>

Remove the Card at the given index.

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

Remove the given Card from the hand if present.

pub fn truncate(&mut self, n: usize)

Truncate the Hand to the given length.

pub fn shuffle(&mut self)

Shuffle the Hand in place.

pub fn sort(&mut self)

Sort the Hand in place.

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

Return an iterator over all n-card combinations of the hand.

pub fn equals(&self, other: &Self) -> bool

Return true if the hands are identical: i.e., same cards in same order.

pub fn is_equivalent_to(&self, other: &Self) -> bool

Return true if the hands are equivalent: i.e., same cards in any order.

pub fn ace_fix(&mut self)

Fix the ace values in the Hand to match the MasterDeck.

pub fn draw(&mut self, n: usize, d: &mut Deck) -> bool

Take n cards from the given Deck and add them to the hand.

pub fn draw_card(&mut self, c: Card, d: &mut Deck) -> bool

Take the given Card from the Deck and add it to the hand.

pub fn draw_hand(&mut self, cl: &[Card], d: &mut Deck) -> bool

Take the given Cards from the Deck and add them to the hand.

impl Hand

pub fn iter(&self) -> CardIter

Return an iterator over the Cards in the hand.

Trait Implementations

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 Debug for Hand

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

Formats the value using the given formatter.

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.

impl FromStr for Hand

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 Index<usize> for Hand

type Output = Card

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Hand

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Hand

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 Hand

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.