Struct freecell::Foundations

pub struct Foundations(pub [Foundation; 4]);

Four stacks of cards, where each stack contains only cards of one suit, going from Ace upwards.

Rules

There exists one foundation for each of the four suits. Cards can only be put on the foundation corresponding to their suit.

An Ace can be put on the foundation of the appropriate suit iff there is no other card on that foundation. This is always the case in a valid game state.

Any other card c can be put on the foundation of the appropriate suit iff the top card on that foundation has a rank exactly one lower than card c.

This means a foundation can hold at most 13 cards: The cards from Ace to King of one suit in order of their ranks, the Ace being on the bottom and the King being on top. The game ends in a victory when all four foundations reach this state.

Once a card is on a foundation, it can never be removed.

Usage

The position of the Foundation in the array determines which suit it holds. Eg. foundations[1] may only hold spade cards, since Suit::Spade equals 1. TODO [high priority] explain more thoroughly

Examples

// TODO [high priority]

Methods

impl Foundations

pub fn new() -> Foundations

Creates empty foundations

pub fn foundation(&self, suit: Suit) -> &Foundation

Returns the foundation of the given suit

Trait Implementations

impl CardCollection for Foundations

fn add_card(&self, card: Card) -> Result<Self, ()>

Attempts to put a card on the foundation of the appropriate suit.

An Ace can be put on a foundation iff there is no other card on the foundation of that suit. This is always the case in a valid game state.

Any other card c can be put on a foundation iff the top card on the foundation of that suit has a rank exactly one lower than card c.

fn pop_card(&self) -> Vec<(Self, Card)>

Always returns an empty Vec, since cards cannot be removed from foundations.

impl Clone for Foundations

fn clone(&self) -> Foundations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Foundations

fn default() -> Foundations

Returns the "default value" for a type.

impl Eq for Foundations

impl PartialEq<Foundations> for Foundations

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

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

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

This method tests for !=.

impl Display for Foundations

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

Formats the value using the given formatter.

impl Debug for Foundations

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

Formats the value using the given formatter.

impl Hash for Foundations

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 StructuralPartialEq for Foundations

impl StructuralEq for Foundations