Struct rust_cards::hand::Hand

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

Fields

vec: Vec<Card>

Implementations

impl Hand

pub fn from(vec: Vec<Card>) -> Hand

returns a hand from a Vec of Card

pub fn full_deck() -> Hand

returns a Hand containing a full deck

ordered 2, 3, 4, … J, Q, K, A Suits ordered Club(♣), Diamond(♦), Heart(♥), Spade(♠)

pub fn shuffle(&self) -> Hand

Randomizes the order of the hand

returns a new value; does not mutate the original value

pub fn reverse(&self) -> Hand

reverses the hand i.e. the first index becomes the last index, the second index becomes the second-last index, etc.Hand

returns a new value; does not mutate the original value

pub fn pop_top(&mut self) -> Card

removes the first indexed card in the hand and returns its value

mutates the hand; doesn’t return a new hand

let mut h = Hand::from(
    vec![
        Card::new(Value::Ace, Suit::Spade)
        Card::new(Value::Two, Suit::Spade)
        Card::new(Value::Three, Suit::Spade)
    ]
);
// A♠, 2♠, 3♠
 
let popped = h.pop();
// h == 2♠, 3♠
// popped == A♠

pub fn pop_bottom(&mut self) -> Card

removes the last indexed card in the hand and returns its value

mutates the hand; doesn’t return a new hand

let mut h = Hand::from(
    vec![
        Card::new(Value::Ace, Suit::Spade)
        Card::new(Value::Two, Suit::Spade)
        Card::new(Value::Three, Suit::Spade)
    ]
);
// A♠, 2♠, 3♠
 
let popped = h.pop();
// h == A♠, 2♠
// popped == 3♠

pub fn push_top(&self, card: Card) -> Hand

Pushes a card to the top of the hand

let mut h = Hand::from(
    vec![
        Card::new(Value::Ace, Suit::Spade)
        Card::new(Value::Two, Suit::Spade)
        Card::new(Value::Three, Suit::Spade)
    ]
);
// A♠, 2♠, 3♠
 
h = h.push(Card::new(Value::King, Suit::Spade))
// K♠, A♠, 2♠, 3♠

pub fn push_bottom(&self, card: Card) -> Hand

Pushes a card to the bottom of the hand

let mut h = Hand::from(
    vec![
        Card::new(Value::Ace, Suit::Spade)
        Card::new(Value::Two, Suit::Spade)
        Card::new(Value::Three, Suit::Spade)
    ]
);
// A♠, 2♠, 3♠
 
h = h.push(Card::new(Value::Four, Suit::Spade))
// A♠, 2♠, 3♠, 4♠

pub fn insert(&self, index: usize, card: Card) -> Hand

pub fn stack_top(&self, hand: Hand) -> Hand

Stacks a hand on top of another Hand

pub fn stack_bottom(&self, hand: Hand) -> 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.