fix Cargo.lock

This reverts commit 2eaa99e82d.

These functions are not necessary.  Remove their usages which are only used in tests and frankenstein code.

Cargo.lock

@@ -22,9 +22,10 @@ checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3"
 
 [[package]]
 name = "card_game"
-version = "0.3.0"
+version = "0.4.0"
 dependencies = [
  "arrayvec",
+ "serde",
 ]
 
 [[package]]
@@ -126,10 +127,11 @@ checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
 
 [[package]]
 name = "klondike"
-version = "0.2.0"
+version = "0.3.0"
 dependencies = [
  "card_game",
  "rand",
+ "serde",
 ]
 
 [[package]]
@@ -238,6 +240,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
 dependencies = [
  "serde_core",
+ "serde_derive",
 ]
 
 [[package]]

Cargo.toml

@@ -8,8 +8,8 @@ members = [
 resolver = "3"
 
 [workspace.dependencies]
-card_game = { version = "0.3.0", path = "card_game", registry = "Quaternions" }
+card_game = { version = "0.4.0", path = "card_game", registry = "Quaternions" }
-klondike = { version = "0.2.0", path = "klondike", registry = "Quaternions" }
+klondike = { version = "0.3.0", path = "klondike", registry = "Quaternions" }
 
 [workspace.lints.rust]
 # unsafe_code = "forbid"

README.md

@@ -0,0 +1 @@
+card_game/README.md

card_game/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "card_game"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2024"
 repository = "https://git.aleshym.co/Quaternions/card_game"
 license = "MIT OR Apache-2.0"
@@ -8,8 +8,12 @@ description = "Card game library."
 authors = ["Rhys Lloyd <krakow20@gmail.com>"]
 keywords = ["card", "cards", "solitaire", "klondike"]
 
+[features]
+serde = ["dep:serde"]
+
 [dependencies]
 arrayvec = { version = "0.7.6", registry = "Quaternions", features = ["len_u8"], default-features = false }
+serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
 
 [lints]
 workspace = true

card_game/src/lib.rs

@@ -28,6 +28,7 @@ pub trait Game: Clone {
 
 /// card_game supports up to 4 identifiably separate decks.
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Deck {
 	Deck1 = 0b00,
 	Deck2 = 0b01,
@@ -48,6 +49,7 @@ impl Deck {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Suit {
 	Spades = 0b00,
 	Hearts = 0b01,
@@ -77,6 +79,7 @@ impl Suit {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Rank {
 	Ace = 1,
 	Two = 2,
@@ -146,6 +149,8 @@ impl Rank {
 /// 2 bits for suit ID
 /// 4 bits for card Value
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(transparent))]
 pub struct Card(core::num::NonZeroU8);
 impl Card {
 	pub const fn new(deck: Deck, suit: Suit, rank: Rank) -> Self {
@@ -317,12 +322,12 @@ pub enum SolveError {
 	MovesBudgetExceeded,
 	StatesBudgetExceeded,
 }
-impl std::fmt::Display for SolveError {
+impl core::fmt::Display for SolveError {
-	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 		write!(f, "{self:?}")
 	}
 }
-impl std::error::Error for SolveError {}
+impl core::error::Error for SolveError {}
 
 /// The solution tends to be very large with long chains of moves that go back to the same state.
 /// It is recommended to call .clean_solution() if the solution is actually going to be shown to a user.
@@ -498,9 +503,9 @@ where
 	/// Attempt to produce a solution.
 	pub fn solve(&self) -> Result<Option<Solution<G>>, SolveError> {
 		let mut state_moves = std::collections::HashMap::new();
-		let mut state = self.clone();
+		let mut session = self.clone();
 		let mut moves = 0;
-		while !state.is_win() {
+		while !session.is_win() {
 			moves += 1;
 			if self.config.solve_moves_budget < moves {
 				return Err(SolveError::MovesBudgetExceeded);
@@ -510,9 +515,9 @@ where
 			}
 			// Continue existing iterator if it exists
 			let it = state_moves
-				.entry(state.state().state().clone())
+				.entry(session.state().state().clone())
 				.or_insert_with(|| {
-					state
+					session
 						.state()
 						.state()
 						.possible_instructions(&self.config().inner)
@@ -520,19 +525,19 @@ where
 
 			// Run one possible move
 			if let Some(instruction) = it.next() {
-				state.process_instruction(instruction);
+				session.process_instruction(instruction);
 				continue;
 			}
 
 			// No more moves. If we can't undo we're done
-			if state.history().is_empty() {
+			if session.history().is_empty() {
 				return Ok(None);
 			} else {
-				state.undo();
+				session.undo();
 			}
 		}
 		Ok(Some(Solution {
-			solution: state.state.history,
+			solution: session.state.history,
 		}))
 	}
 }
@@ -540,7 +545,7 @@ impl<G: Game<Score = i32>> Game for SessionState<G>
 where
 	G::Stats: Default,
 {
-	type Score = i32;
+	type Score = G::Score;
 	type Stats = SessionStats<G::Stats>;
 	type Config = SessionConfig<G::Config>;
 	type Instruction = SessionInstruction<G::Instruction>;

klondike-cli/src/main.rs

@@ -117,7 +117,7 @@ impl Display for DisplayStats<'_> {
 			self.0.stats().stats().recycle_count(),
 			self.0.stats().stats().moves(),
 			self.0.stats().undos(),
-			self.0.state().score(self.0.stats(), &self.0.config()),
+			self.0.state().score(self.0.stats(), self.0.config()),
 		)
 	}
 }
@@ -239,7 +239,7 @@ fn main() -> Result<(), std::io::Error> {
 	use rand::RngExt;
 	let mut rng = rand::rng();
 	// seed from cli argument
-	let mut seed = if let Some(seed) = std::env::args().skip(1).next() {
+	let mut seed = if let Some(seed) = std::env::args().nth(1) {
 		seed.parse().expect("Invalid u64 seed")
 	} else {
 		rng.random()

klondike/Cargo.toml

@@ -1,11 +1,15 @@
 [package]
 name = "klondike"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2024"
 
+[features]
+serde = ["dep:serde"]
+
 [dependencies]
 card_game.workspace = true
 rand = { version = "0.10.1", default-features = false, features = ["std_rng"] }
+serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
 
 [lints]
 workspace = true

klondike/src/lib.rs

@@ -121,6 +121,7 @@ impl KlondikeStats {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Tableau {
 	Tableau1,
 	Tableau2,
@@ -147,6 +148,7 @@ impl Tableau {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Foundation {
 	Foundation1,
 	Foundation2,
@@ -167,6 +169,7 @@ impl Foundation {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KlondikePile {
 	Tableau(Tableau),
 	Stock,
@@ -200,6 +203,7 @@ impl From<Foundation> for KlondikePile {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum SkipCards {
 	Skip0,
 	Skip1,
@@ -238,6 +242,7 @@ impl SkipCards {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct TableauStack {
 	pub tableau: Tableau,
 	pub skip_cards: SkipCards,
@@ -271,6 +276,7 @@ impl TableauStack {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KlondikePileStack {
 	Tableau(TableauStack),
 	Stock,
@@ -294,6 +300,7 @@ impl KlondikePileStack {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct DstFoundation {
 	pub src: KlondikePile,
 	pub foundation: Foundation,
@@ -317,6 +324,7 @@ impl DstFoundation {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct DstTableau {
 	pub src: KlondikePileStack,
 	pub tableau: Tableau,
@@ -340,6 +348,7 @@ impl DstTableau {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KlondikeInstruction {
 	DstFoundation(DstFoundation),
 	DstTableau(DstTableau),
@@ -377,54 +386,55 @@ const fn sum(n: usize) -> usize {
 	n * (n + 1) / 2
 }
 const STOCK: usize = 52 - sum(TABLEAUS);
+const NUM_RANKS: usize = Rank::RANKS.len();
 
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub struct KlondikeState {
 	stock: Pile<STOCK, STOCK>,
-	foundations: [Stack<13>; 4],
+	foundations: [Stack<NUM_RANKS>; 4],
-	tableau1: Pile<0, 13>,
+	tableau1: Pile<0, NUM_RANKS>,
-	tableau2: Pile<1, 13>,
+	tableau2: Pile<1, NUM_RANKS>,
-	tableau3: Pile<2, 13>,
+	tableau3: Pile<2, NUM_RANKS>,
-	tableau4: Pile<3, 13>,
+	tableau4: Pile<3, NUM_RANKS>,
-	tableau5: Pile<4, 13>,
+	tableau5: Pile<4, NUM_RANKS>,
-	tableau6: Pile<5, 13>,
+	tableau6: Pile<5, NUM_RANKS>,
-	tableau7: Pile<6, 13>,
+	tableau7: Pile<6, NUM_RANKS>,
 }
 impl KlondikeState {
 	pub const fn stock(&self) -> &Pile<STOCK, STOCK> {
 		&self.stock
 	}
-	pub const fn foundation1(&self) -> &Stack<13> {
+	pub const fn foundation1(&self) -> &Stack<NUM_RANKS> {
 		&self.foundations[Foundation::Foundation1 as usize]
 	}
-	pub const fn foundation2(&self) -> &Stack<13> {
+	pub const fn foundation2(&self) -> &Stack<NUM_RANKS> {
 		&self.foundations[Foundation::Foundation2 as usize]
 	}
-	pub const fn foundation3(&self) -> &Stack<13> {
+	pub const fn foundation3(&self) -> &Stack<NUM_RANKS> {
 		&self.foundations[Foundation::Foundation3 as usize]
 	}
-	pub const fn foundation4(&self) -> &Stack<13> {
+	pub const fn foundation4(&self) -> &Stack<NUM_RANKS> {
 		&self.foundations[Foundation::Foundation4 as usize]
 	}
-	pub const fn tableau1(&self) -> &Pile<0, 13> {
+	pub const fn tableau1(&self) -> &Pile<0, NUM_RANKS> {
 		&self.tableau1
 	}
-	pub const fn tableau2(&self) -> &Pile<1, 13> {
+	pub const fn tableau2(&self) -> &Pile<1, NUM_RANKS> {
 		&self.tableau2
 	}
-	pub const fn tableau3(&self) -> &Pile<2, 13> {
+	pub const fn tableau3(&self) -> &Pile<2, NUM_RANKS> {
 		&self.tableau3
 	}
-	pub const fn tableau4(&self) -> &Pile<3, 13> {
+	pub const fn tableau4(&self) -> &Pile<3, NUM_RANKS> {
 		&self.tableau4
 	}
-	pub const fn tableau5(&self) -> &Pile<4, 13> {
+	pub const fn tableau5(&self) -> &Pile<4, NUM_RANKS> {
 		&self.tableau5
 	}
-	pub const fn tableau6(&self) -> &Pile<5, 13> {
+	pub const fn tableau6(&self) -> &Pile<5, NUM_RANKS> {
 		&self.tableau6
 	}
-	pub const fn tableau7(&self) -> &Pile<6, 13> {
+	pub const fn tableau7(&self) -> &Pile<6, NUM_RANKS> {
 		&self.tableau7
 	}
 	pub fn tableau_face_down_cards(&self, tableau: Tableau) -> &[Card] {
@@ -461,14 +471,20 @@ impl KlondikeState {
 			KlondikePileStack::Stock => self.stock.face_up().last(),
 		}
 	}
-	pub fn top_card<S: Into<KlondikePile>>(&self, src: S) -> Option<&Card> {
+	pub fn tableau_top_card(&self, tableau: Tableau) -> Option<&Card> {
-		match src.into() {
+		self.tableau_face_up_cards(tableau).last()
-			KlondikePile::Tableau(tableau) => self.tableau_face_up_cards(tableau).last(),
+	}
-			KlondikePile::Foundation(foundation) => self.foundations[foundation as usize].last(),
+	pub fn foundation_top_card(&self, foundation: Foundation) -> Option<&Card> {
+		self.foundations[foundation as usize].last()
+	}
+	pub fn top_card(&self, pile: KlondikePile) -> Option<&Card> {
+		match pile {
+			KlondikePile::Tableau(tableau) => self.tableau_top_card(tableau),
+			KlondikePile::Foundation(foundation) => self.foundation_top_card(foundation),
 			KlondikePile::Stock => self.stock.face_up().last(),
 		}
 	}
-	fn take_stack(&mut self, src: KlondikePileStack) -> (Stack<13>, bool) {
+	fn take_stack_flip_up(&mut self, src: KlondikePileStack) -> (Stack<NUM_RANKS>, bool) {
 		match src {
 			KlondikePileStack::Tableau(TableauStack {
 				tableau,
@@ -489,8 +505,8 @@ impl KlondikeState {
 			KlondikePileStack::Stock => (Stack::from_iter(self.stock.pop()), false),
 		}
 	}
-	fn take_top_card<S: Into<KlondikePile>>(&mut self, src: S) -> (Option<Card>, bool) {
+	fn take_top_card_flip_up(&mut self, pile: KlondikePile) -> (Option<Card>, bool) {
-		match src.into() {
+		match pile {
 			KlondikePile::Tableau(tableau) => match tableau {
 				Tableau::Tableau1 => self.tableau1.pop_flip_up(),
 				Tableau::Tableau2 => self.tableau2.pop_flip_up(),
@@ -540,7 +556,7 @@ impl KlondikeState {
 			KlondikeInstruction::DstFoundation(dst_foundation) => {
 				// get the top cards
 				if let Some(src_card) = self.top_card(dst_foundation.src) {
-					match self.top_card(dst_foundation.foundation) {
+					match self.foundation_top_card(dst_foundation.foundation) {
 						// destination card exists
 						Some(dst_card) => {
 							// suit matches?
@@ -564,7 +580,7 @@ impl KlondikeState {
 				}
 				// get the cards
 				if let Some(src_card) = self.stack_bottom_card(dst_tableau.src) {
-					match self.top_card(dst_tableau.tableau) {
+					match self.tableau_top_card(dst_tableau.tableau) {
 						// destination card exists
 						Some(dst_card) => {
 							// red-ness is opposite?
@@ -624,7 +640,9 @@ impl Klondike {
 		let mut deck = deck.into_iter();
 
 		// generate tableaus
-		fn pile<const DN: usize>(deck: &mut <Stack<52> as IntoIterator>::IntoIter) -> Pile<DN, 13> {
+		fn pile<const DN: usize>(
+			deck: &mut <Stack<52> as IntoIterator>::IntoIter,
+		) -> Pile<DN, NUM_RANKS> {
 			let stack = Stack::from_iter(deck.take(DN));
 			let mut pile = Pile::new_face_down(stack);
 			pile.push(deck.next().unwrap());
@@ -756,7 +774,7 @@ impl Game for Klondike {
 			// Move a card from anywhere to a foundation
 			KlondikeInstruction::DstFoundation(DstFoundation { src, foundation }) => {
 				stats.increment_move_to_foundation();
-				let (card, did_flip_up) = self.state.take_top_card(src);
+				let (card, did_flip_up) = self.state.take_top_card_flip_up(src);
 				if did_flip_up {
 					stats.increment_flip_up_bonus();
 				}
@@ -767,9 +785,9 @@ impl Game for Klondike {
 				match src {
 					KlondikePileStack::Stock => stats.increment_move_to_tableau(),
 					KlondikePileStack::Foundation(_) => stats.increment_move_from_foundation(),
-					_ => {}
+					KlondikePileStack::Tableau(_) => {}
 				}
-				let (cards, did_flip_up) = self.state.take_stack(src);
+				let (cards, did_flip_up) = self.state.take_stack_flip_up(src);
 				if did_flip_up {
 					stats.increment_flip_up_bonus();
 				}