Struct playing_cards::core::CardDeck

pub struct CardDeck { /* private fields */ }

A deck of cards

This deck will contain 52 distinct cards upon initialization. To ensure uniform randomness, the Xoshiro256PlusPlus pseudorandom generator is used when the deck is shuffled and every time when the muck is reshuffled back in.

Example

use playing_cards::core::CardDeck;

let mut deck: CardDeck = Default::default();
deck.shuffle(None);

let hand = deck.deal_cards(2, false);

println!("{:?}", hand.unwrap()); // Two random cards from the deck

Implementations

impl CardDeck

pub fn new(seed: Option<[u8; 32]>) -> Result<Self, CardDeckError>

Creates a new shuffled or unshuffled CardDeck

This method is a way to create deterministic deck for random but predictable outcomes. Please note that this method will attempt to shuffle the deck if a seed is provided, but if shuffling fails, new_with_seed() will return an error.

If no seed is provided, then an unshuffled deck is returned. This is identical to the behavior of Default::default().

Example

use playing_cards::core::CardDeck;

for _ in 0..10 {
    let mut deck: CardDeck = Default::default();

    // Since we did not shuffle the deck of cards, we should see cards in descending order.
    for (i, card) in (52..0).zip(deck) {
        assert_eq!(i, Into::<i32>::into(card));
    }
}

use playing_cards::core::CardDeck;

for _ in 0..10 {
    let mut seed_bytes = Vec::from(1337_u32.to_ne_bytes());
    seed_bytes.extend_from_slice(&[0u8; 28]);
    let mut deck = CardDeck::new(Some(seed_bytes.as_slice().try_into().unwrap())).unwrap();

    // Every single line should produce the same 5 cards in the same exact order because
    // we gave each deck the same seed.
    let hand = deck.deal_cards(5, false);
    println!("{:?}", hand.unwrap());
}

use playing_cards::core::CardDeck;

for i in 0..10 {
    let mut seed_bytes = Vec::from((i as u32).to_ne_bytes());
    seed_bytes.extend_from_slice(&[0u8; 28]);
    let mut deck = CardDeck::new(Some(seed_bytes.as_slice().try_into().unwrap())).unwrap();

    // Each line should be different from one another, but if you rerun this code again,
    // it will print out the exact 10 lines again.
    let hand = deck.deal_cards(5, false);
    println!("{:?}", hand.unwrap());
}

If you do provide a seed to new(), the cards within the deck can be predicted if the seed generation is predictable (e.g. incrementing the seed by one, using UNIX time). It is better to use new() in these cases since the entropy from the system cannot be replicated across systems easily unless the seed generated is shared.

pub fn new_custom_deck( cards: Vec<Card>, seed: Option<[u8; 32]> ) -> Result<Self, CardDeckError>

Creates a new CardDeck with provided cards

Useful if a standard 52-card deck does not fulfill your needs.

Will attempt to shuffle deck if a seed is provided. An error will return if shuffling fails. If no seed is provided, the deck remains unshuffled.

pub fn shuffle(&mut self, seed: Option<[u8; 32]>) -> Result<(), CardDeckError>

Shuffles the deck

An optional seed can be provided if the deck should be shuffled with a specific seed. If no seed is provided, then system entropy is sampled for a random seed.

pub fn get_seed(&self) -> Option<[u8; 32]>

👎Deprecated since 0.1.2: rand_core::SeedableRng does not support the Clone trait, so CardDeck has no feasible way of storing the seed after moving it into the PRNG for shuffling. It is reccommended that the user stores the intial seed if the seed had value after PRNG seeding.

Gets the Xoshiro256PlusPlus seed of the CardDeck

pub fn strip_cards(&mut self, cards_to_remove: &HashSet<Card>) -> Vec<Card>

Searches the deck and removes cards within provided set of cards

Returns back a list of cards that were removed from the deck. Duplicates can be present in the returned vector if duplicates existed in the deck.

pub fn strip_ranks(&mut self, ranks_to_remove: &HashSet<Value>) -> Vec<Card>

Searches the deck and removes cards within provided set of ranks/values

Returns back a list of cards that were removed from the deck. Duplicates can be present in the returned vector if duplicates existed in the deck.

pub fn strip_suits(&mut self, suits_to_remove: &HashSet<Suit>) -> Vec<Card>

Searches the deck and removes cards within provided set of suits

Returns back a list of cards that were removed from the deck. Duplicates can be present in the returned vector if duplicates existed in the deck.

pub fn muck_cards(&mut self, cards: Vec<Card>)

Adds the inputted cards into the muck

This is primarily important if reshuffling the muck can occur.

pub fn check_deal_cards(&self, cards_to_deal: usize, include_muck: bool) -> bool

Checks to see if there are enough cards in the deck to deal

Returns true if there are enough cards, false otherwise.

pub fn deal_cards( &mut self, cards_to_deal: usize, include_muck: bool ) -> Option<Vec<Card>>

Deals n cards out from the CardDeck

If there is not enough cards remaining in the deck, it will reshuffle the mucked card back into the deck and redeal them out. If there are no more cards left, this method will return None. The method also returns

Examples

use playing_cards::core::{Card, CardDeck};

let mut player_hands: Vec<Vec<Card>> = Vec::new();

let mut deck: CardDeck = Default::default();
deck.shuffle(None);

for i in 0..10 {
    if let Some(hand) = deck.deal_cards(2, false) { // 2 cards per player would require 20 cards
        player_hands.push(hand);
    } else {
        unreachable!("Ran out of cards!");
    }
}

println!("{:?}", player_hands);

 use playing_cards::core::{Card, CardDeck};

let mut player_hands: Vec<Vec<Card>> = Vec::new();

let mut deck: CardDeck = Default::default();
deck.shuffle(None);

for i in 0..10 {
    if let Some(hand) = deck.deal_cards(6, false) { // 6 cards per player would require 60 cards, but there's only 52
        player_hands.push(hand);
    } else {
        panic!("Ran out of cards!");
    }
}

unreachable!();

pub fn draw_cards( &mut self, cards_to_deal: usize, discard_cards: Option<Vec<Card>>, include_muck: bool ) -> Option<Vec<Card>>

Draws n cards out from the CardDeck

The definition of drawing in this case means to discard and replace cards. This function can take any number of discard cards with the help of muck_cards() and then simply invokes deal_cards() to deal n cards out of the deck.

pub fn reshuffle_muck( &mut self, seed: Option<[u8; 32]> ) -> Result<(), CardDeckError>

Reshuffles the muck and inserts those cards into the deck

The muck will be placed behind the remaining cards in the deck.

Similar to shuffle(), this function takes in an optional seed if a specific seed is desired. If no seed is provided, a seed will be sampled from entropy.

Trait Implementations

impl Clone for CardDeck

fn clone(&self) -> CardDeck

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CardDeck

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

Formats the value using the given formatter.

impl Default for CardDeck

fn default() -> Self

Returns the “default value” for a type.

impl Iterator for CardDeck

type Item = Card

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn next_chunk<const N: usize>( &mut self ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usizewhere Self: Sized,

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>where Self: Sized,

Consumes the iterator, returning the last element.

fn advance_by(&mut self, n: usize) -> Result<(), NonZeroUsize>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs.

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places a copy of separator between adjacent items of the original iterator.

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F)where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P>where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps.

fn skip(self, n: usize) -> Skip<Self>where Self: Sized,

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure.

fn fuse(self) -> Fuse<Self>where Self: Sized,

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F>where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> Bwhere B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection.

fn collect_into<E>(self, collection: &mut E) -> &mut Ewhere E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B)where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it.

fn is_partitioned<P>(self, predicate: P) -> boolwhere Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> Rwhere Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> Rwhere Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> Bwhere Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn reduce<F>(self, f: F) -> Option<Self::Item>where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.

fn try_reduce<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryTypewhere Self: Sized, F: FnMut(Self::Item, Self::Item) -> R, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.

fn all<F>(&mut self, f: F) -> boolwhere Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> boolwhere Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B>where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result.

fn try_find<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryTypewhere Self: Sized, F: FnMut(&Self::Item) -> R, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns the first true result or the first error.

fn position<P>(&mut self, predicate: P) -> Option<usize>where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item>where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item>where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self>where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self>where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements.

fn cycle(self) -> Cycle<Self>where Self: Sized + Clone,

Repeats an iterator endlessly.

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time.

fn sum<S>(self) -> Swhere Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator.

fn product<P>(self) -> Pwhere Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements

fn cmp_by<I, F>(self, other: I, cmp: F) -> Orderingwhere Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn partial_cmp<I>(self, other: I) -> Option<Ordering>where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> boolwhere Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another.

fn lt<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted_by<F>(self, compare: F) -> boolwhere Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> boolwhere Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd<K>,

🔬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given key extraction function.