Struct stochasta::playing_cards::PlayingCardDeck

pub struct PlayingCardDeck { /* private fields */ }

A builder for quickly creating decks of playing cards.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .value_range(PlayingCardValue::Seven, PlayingCardValue::Ace)
    .all_suits()
    .set_count(2)
    .to_deck();
println!("{:?}", deck);
assert_eq!(deck.size(), 64);

Implementations

impl PlayingCardDeck

pub fn new() -> Self

Constructs a new empty deck.

Example

use stochasta::playing_cards::PlayingCardDeck;

let deck = PlayingCardDeck::new();
assert!(deck.is_empty())

pub fn set_values<I>(self, values: I) -> Self

where I: IntoIterator<Item = PlayingCardValue>,

Sets the values.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .set_values([PlayingCardValue::Ten, PlayingCardValue::Ace])
    .set_suits([PlayingCardSuit::Hearts])
    .to_deck();

assert_eq!(deck.size(), 2);
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Ten, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Ace, PlayingCardSuit::Hearts)));

pub fn set_suits<I>(self, suits: I) -> Self

where I: IntoIterator<Item = PlayingCardSuit>,

Sets the suits.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .set_values([PlayingCardValue::Ace])
    .set_suits([PlayingCardSuit::Hearts, PlayingCardSuit::Clubs])
    .to_deck();

assert_eq!(deck.size(), 2);
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Ace, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Ace, PlayingCardSuit::Clubs)));

pub fn value_range(self, from: PlayingCardValue, to: PlayingCardValue) -> Self

Sets the value range. (both inclusive)

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .value_range(PlayingCardValue::Jack, PlayingCardValue::Ace)
    .set_suits([PlayingCardSuit::Hearts])
    .to_deck();

assert_eq!(deck.size(), 4);
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Jack, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Queen, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::King, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Ace, PlayingCardSuit::Hearts)));

pub fn all_values(self) -> Self

Sets all PlayingCardValues to be included.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .all_values()
    .set_suits([PlayingCardSuit::Hearts])
    .to_deck();

assert_eq!(deck.size(), 13);
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Two, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Ten, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Ace, PlayingCardSuit::Hearts)));

pub fn all_suits(self) -> Self

Sets all PlayingCardSuits inclusive.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .set_values([PlayingCardValue::Two])
    .all_suits()
    .to_deck();

assert_eq!(deck.size(), 4);
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Two, PlayingCardSuit::Diamonds)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Two, PlayingCardSuit::Hearts)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Two, PlayingCardSuit::Clubs)));
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Two, PlayingCardSuit::Spades)));

pub fn set_count(self, count: u64) -> Self

Sets the count of each individual card.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .set_values([PlayingCardValue::Two])
    .set_suits([PlayingCardSuit::Hearts])
    .set_count(4)
    .to_deck();

assert_eq!(deck.size(), 4);
assert!(deck.contains(&PlayingCard::new(PlayingCardValue::Two, PlayingCardSuit::Hearts)));

pub fn to_deck(&self) -> CardDeck<PlayingCard>

Converts this to a CardDeck.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

let deck = PlayingCardDeck::new()
    .all_values()
    .all_suits()
    .set_count(2)
    .to_deck();

assert_eq!(deck.size(), 13 * 4 * 2);

pub fn is_empty(&self) -> bool

Returns true if deck contains no cards.

Example

use stochasta::playing_cards::{PlayingCard, PlayingCardDeck, PlayingCardSuit, PlayingCardValue};

assert!(PlayingCardDeck::new().is_empty());

Trait Implementations

impl Clone for PlayingCardDeck

fn clone(&self) -> PlayingCardDeck

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlayingCardDeck

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

Formats the value using the given formatter.

impl Default for PlayingCardDeck

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PlayingCardDeck

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PlayingCardDeck

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

Formats the value using the given formatter.

impl Hash for PlayingCardDeck

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PlayingCardDeck

fn cmp(&self, other: &PlayingCardDeck) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PlayingCardDeck

fn eq(&self, other: &PlayingCardDeck) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PlayingCardDeck

fn partial_cmp(&self, other: &PlayingCardDeck) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PlayingCardDeck

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PlayingCardDeck

impl Eq for PlayingCardDeck

impl StructuralPartialEq for PlayingCardDeck