Enum open_ttt_lib::game::State

pub enum State {
    PlayerXMove,
    PlayerOMove,
    PlayerXWin(HashSet<Position>),
    PlayerOWin(HashSet<Position>),
    CatsGame,
}

Indicates the state of the game.

The set of positions provided to PlayerXWin and PlayerOWin contain all the positions that contributed to the victory. Usually, this will be positions representing a row, column, or diagonal. However, there are some situations where more than one row, column, or diagonal contributed to a victory.

Variants

PlayerXMove

Player X's turn to mark a free position.

PlayerOMove

Player O's turn to mark a free position.

PlayerXWin(HashSet<Position>)

Player X has won the game. The set of positions that contributed to the win are provided as the enum value.

PlayerOWin(HashSet<Position>)

Player O has won the game. The set of positions that contributed to the win are provided as the enum value.

CatsGame

The game has ended in a draw where there are no winners.

Methods

impl State

pub fn is_game_over(&self) -> bool

Indicates if the state represents one of the game over states.

If either player has won or it is a cat's game then true is returned; otherwise, false is returned.

Examples

use open_ttt_lib::game;

assert!(!game::State::PlayerXMove.is_game_over());
assert!(game::State::CatsGame.is_game_over());

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Eq for State

impl PartialEq<State> for State

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

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

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

This method tests for !=.

impl StructuralEq for State

impl StructuralPartialEq for State