Struct cardpack::cards::decks::standard52::Standard52

pub struct Standard52 {
    pub pack: Pack,
    pub deck: Pile,
}

Standard52 is a representation of a deck of cards used to play most versions of poker. It is useful to determine if a Card belongs in the deck and to deserialize Cards, Piles and decks from index strings.

Fields

pack: Pack

deck: Pile

Implementations

impl Standard52

pub fn new_from_pile(pile: Pile) -> Result<Standard52, DeckError>

Errors

Will return DeckError::PilePackMismatch error if Pile passed in isn’t a FrenchDeck.

pub fn new_shuffled() -> Self

pub fn from_index(card_str: &'static str) -> Result<Standard52, DeckError>

Errors

Will return DeckError::InvalidIndex if passed in index is incomplete.

pub fn pile_from_index(card_str: &'static str) -> Result<Pile, DeckError>

Errors

Will return DeckError::InvalidIndex if passed in index is invalid.

pub fn pile_from_index_validated( card_str: &'static str ) -> Result<Pile, DeckError>

Validating method that takes a Standard52 index string and returns a Pile, making sure that there are no duplicate valid cards in the string.

This method is doing a lot :-P

Errors

Will return DeckError::InvalidIndex if passed in index is invalid. Will return DeckError::DuplicateCard if the index has the same Card more than once.

Panics

Should not be possible.

pub fn pile_from_pile(&self, pile: Pile) -> Result<Pile, DeckError>

Errors

Will return DeckError::PilePackMismatch if Pile passed contains a card that isn’t in the Standard52 deck.

pub fn draw(&mut self, x: usize) -> Option<Pile>

pub fn to_index(&self) -> String

pub fn to_index_str(&self) -> &'static str

pub fn to_symbol_index(&self) -> String

pub fn is_complete(&self) -> bool

A Standard52 deck is complete if a sorted Pile of the deck is equal to it’s Pack.

pub fn card_from_index(index: &'static str) -> Card

pub fn card_from_string(index: String) -> Card

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

pub fn sort_by_suit(pile: &Pile) -> HashMap<Suit, Pile>

Returns HashMap of Piles of Cards sorted by the Standard52 Suits.

https://doc.rust-lang.org/std/collections/struct.HashMap.html#method.entry// https://www.reddit.com/r/rust/comments/9xho3i/i_have_a_hashmap_that_pairs_strings_with_vectors//

pub fn is_flush(pile: &Pile) -> bool

Returns true if five or more cards in a Pile are of the same Suit.

NOTE: This method is non optimal and is primarily for verification purposes.

Trait Implementations

impl Clone for Standard52

fn clone(&self) -> Standard52

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Standard52

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

Formats the value using the given formatter.

impl Default for Standard52

fn default() -> Standard52

Returns the “default value” for a type.

impl Display for Standard52

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

Formats the value using the given formatter.

impl Hash for Standard52

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 PartialEq for Standard52

fn eq(&self, other: &Standard52) -> 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 StructuralPartialEq for Standard52