Struct rs_poker::core::FlatDeck

pub struct FlatDeck { /* fields omitted */ }

FlatDeck is a deck of cards that allows easy indexing into the cards. It does not provide contains methods.

Methods

impl FlatDeck

#[must_use] pub fn len(&self) -> usize

How many cards are there in the deck ?

#[must_use] pub fn is_empty(&self) -> bool

Have all cards been dealt ? This probably won't be used as it's unlikely that someone will deal all 52 cards from a deck.

#[must_use] pub fn sample(&self, n: usize) -> Vec<Card>

Give a random sample of the cards still left in the deck

pub fn shuffle(&mut self)

Randomly shuffle the flat deck. This will ensure the there's no order to the deck.

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

Deal a card if there is one there to deal. None if the deck is empty

Trait Implementations

impl Into<FlatDeck> for Deck

#[must_use] fn into(self) -> FlatDeck

Flatten a Deck into a FlatDeck.

impl<'a> IntoIterator for &'a FlatDeck

This is useful for trying every possible 5 card hand

Probably not something that's going to be done in real use cases, but still not bad.

type Item = Vec<Card>

The type of the elements being iterated over.

type IntoIter = CardIter<'a>

Which kind of iterator are we turning this into?

Important traits for CardIter<'a>

impl<'a> Iterator for CardIter<'a> type Item = Vec<Card>;

#[must_use] fn into_iter(self) -> CardIter<'a>

Creates an iterator from a value.

impl Debug for FlatDeck

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

Formats the value using the given formatter.

impl Index<usize> for FlatDeck

type Output = Card

The returned type after indexing.

#[must_use] fn index(&self, index: usize) -> &Card

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for FlatDeck

type Output = [Card]

The returned type after indexing.

#[must_use] fn index(&self, index: Range<usize>) -> &[Card]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for FlatDeck

type Output = [Card]

The returned type after indexing.

#[must_use] fn index(&self, index: RangeTo<usize>) -> &[Card]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for FlatDeck

type Output = [Card]

The returned type after indexing.

#[must_use] fn index(&self, index: RangeFrom<usize>) -> &[Card]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for FlatDeck

type Output = [Card]

The returned type after indexing.

#[must_use] fn index(&self, index: RangeFull) -> &[Card]

Performs the indexing (container[index]) operation.