Struct cl_wordle::game::Game

pub struct Game { /* private fields */ }

A Wrapper over State that manages creation and playing of games

Implementations

impl Game

pub fn new(word_set: WordSet<'static>) -> Result<Self>

Create a new game based on the current date (official style)

pub fn custom(solution: String, word_set: WordSet<'static>) -> Result<Self>

Create a new game based on the given word

pub fn from_date(date: Date, word_set: WordSet<'static>) -> Self

Create a new game based on the given date

pub fn from_day(day: usize, word_set: WordSet<'static>) -> Self

Create a new game based on the given day number

pub fn hard_mode(&mut self)

Sets the play style of this game to ‘hard mode’. This means that any exact matches found must be re-used in later guesses

pub fn game_type(&self) -> GameType

Get the GameType for this game

pub fn guess(&mut self, word: &str) -> Result<Matches, GuessError>

Make a guess.

Errors

If the guess is an invalid word, or if it doesn’t match the requirements of hard mode, this function will return an error

pub fn share(self) -> GameShare

Display the share card for this game

use cl_wordle::game::Game;
let mut game = Game::from_day(0, cl_wordle::words::NYTIMES);
game.guess("crane").unwrap();
game.guess("carts").unwrap();
game.guess("chair").unwrap();
game.guess("cigar").unwrap();

let share = game.share();
let score_card = format!("{}", share);
assert_eq!(score_card, r"Wordle 0 4/6
🟩🟨🟨⬛⬛
🟩🟨🟨⬛⬛
🟩⬛🟨🟨🟩
🟩🟩🟩🟩🟩");

Methods from Deref<Target = State>

pub fn solution(&self) -> &str

Reveal the solution for the current game state

pub fn guesses(&self) -> StateIter<'_>

Returns an iterator over the previous guesses

pub fn game_over(&self) -> Option<GameOver>

Determine if the game is over.

pub fn display_score_card(&self, w: impl Write, hard: bool) -> Result

Displays the score card for this game state to the given fmt::Write.

Trait Implementations

impl Deref for Game

type Target = State

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.