Struct cardpack::Pile

pub struct Pile(_);

A Pile is a sortable collection of Cards.

Usage:

let mut pile = cardpack::Pile::default();
let ace_of_spades = cardpack::Card::new(cardpack::ACE, cardpack::SPADES);
let ace_of_hearts = cardpack::Card::new(cardpack::ACE, cardpack::HEARTS);
pile.add(ace_of_spades);
pile.add(ace_of_hearts);
pile.shuffle();

Implementations

impl Pile

pub fn new_from_vector(v: Vec<Card>) -> Pile

pub fn pile_on(piles: Vec<Pile>) -> Pile

Takes a reference to an Array of Piles and consolidates them into a single Pile of Cards.

pub fn pile_up<F>(x: usize, f: F) -> Pile where
    F: Fn() -> Pile, 

Allows you to pass in an integer and a Pile returning function method and creates a Pile made up of the Piles generated that many times.

Usage:

let pile = cardpack::Pile::pile_up(6, cardpack::Pile::french_deck);
pile.shuffle();

This creates and shuffles a Pile made up of six traditional French decks, which would be suitable for a casino blackjack table.

pub fn add(&mut self, elem: Card)

Places the Card at the bottom (end) of the Pile.

pub fn append(&mut self, other: &Pile)

Appends a clone of the passed in Pile of Cards to the existing Pile.

pub fn by_index(&self) -> String

pub fn by_index_locale(&self, lid: &LanguageIdentifier) -> String

pub fn by_symbol_index(&self) -> String

pub fn by_symbol_index_locale(&self, lid: &LanguageIdentifier) -> String

pub fn card_by_index(&self, index: &str) -> Option<&Card>

pub fn cards(&self) -> &Vec<Card>

Returns a reference to the Vector containing all the cards.

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

Tests if a card is in the Pile.

pub fn contains_all(&self, pile: &Pile) -> bool

Tests if every element is inside the Pile.

pub fn demo(&self)

This function is designed to demonstrate the capabilities of the library.

pub fn demo_short(&self)

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

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

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

pub fn first(&self) -> Option<&Card>

pub fn get(&self, index: usize) -> Option<&Card>

pub fn get_random(&self) -> Option<&Card>

pub fn is_empty(&self) -> bool

pub fn last(&self) -> Option<&Card>

pub fn len(&self) -> usize

pub fn map_by_suit(&self) -> HashMap<Suit, Pile>

Takes a pile and returns a HashMap with the key as each Suit in the Pile with the values as a Pile of the cards for that Suit.

pub fn position(&self, karte: &Card) -> Option<usize>

pub fn pile_by_index(&self, indexes: &[&str]) -> Option<Pile>

pub fn prepend(&mut self, other: &Pile)

pub fn rank_indexes(&self) -> String

Returns a String of all of the Rank Index Characters for a Pile.

pub fn remove(&mut self, index: usize) -> Card

pub fn remove_card(&mut self, card: &Card) -> Option<Card>

pub fn shuffle(&self) -> Pile

pub fn shuffle_in_place(&mut self)

pub fn sort(&self) -> Pile

pub fn sort_in_place(&mut self)

pub fn suits(&self) -> Vec<Suit>

Returns a sorted collection of the unique Suits in a Pile.

pub fn values(&self) -> impl Iterator<Item = &Card>

pub fn jokers() -> Pile

pub fn canasta_base_single_deck() -> Pile

pub fn canasta_single_deck() -> Pile

pub fn euchre_deck() -> Pile

pub fn french_deck() -> Pile

pub fn french_deck_with_jokers() -> Pile

pub fn pinochle_deck() -> Pile

pub fn skat_deck() -> Pile

pub fn spades_deck() -> Pile

pub fn tarot_deck() -> Pile

pub fn sig_generate_from_strings(strings: &[String]) -> String

Trait Implementations

impl Clone for Pile

fn clone(&self) -> Pile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pile

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

Formats the value using the given formatter.

impl Default for Pile

fn default() -> Self

Returns the "default value" for a type.

impl Display for Pile

Sets the to_string() function for a Pile to return the default index signature for the Pile.

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

Formats the value using the given formatter.

impl FromIterator<Card> for Pile

fn from_iter<T: IntoIterator<Item = Card>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Pile

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, 

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Pile

type Item = Card

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Pile> for Pile

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

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

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

This method tests for !=.

impl StructuralPartialEq for Pile