Struct hexgame::Game

pub struct Game { /* private fields */ }

Game holds the full state of a game of Hex and allows to manipulate this state by playing valid moves.

The game state consists of a board (get_board) and the current player (get_current_player).

Implementations

impl Game

pub fn new(size: CoordValue) -> Game

Create a new game with the given board size. Boards are always square.

Games always start with black.

This method will panic if the size is not bounded by MIN_BOARD_SIZE and MAX_BOARD_SIZE.

pub fn get_board(&self) -> &Board

Return the game’s board.

pub fn get_current_player(&self) -> Option<Color>

Return the current player, or None if the game has ended.

pub fn get_status(&self) -> Status

pub fn load(
    stones: StoneMatrix,
    current_player: Option<Color>
) -> Result<Self, InvalidBoard>

Load a game from a StoneMatrix and a current player color.

This method returns an error if current_player is None, but the game has not yet finished. Conversely, if the game has finished, current_player will be ignored.

Please also have a look at the Serialization trait which allows to directly deserialize a game from JSON.

pub fn play(&mut self, coords: Coords) -> Result<(), InvalidMove>

Let the current player place a stone at the given coordinates. If the move is invalid, this method returns an error. This method will automatically update the current player.

Trait Implementations

impl Clone for Game

fn clone(&self) -> Game

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Serialization for Game

fn save_to_json(&self) -> Value

Save this game as a Serde JSON value

fn load_from_json(value: Value) -> Result<Self>

Load a game from a Serde JSON value.

fn save_to_string(&self) -> String

Save this game to a JSON string.

fn load_from_str(string: &str) -> Result<Self>

Load a game from a JSON string.