Struct Game 

pub struct Game { /* private fields */ }

The Backgammon Game

This struct holds all the fields necessary to play a single round of Backgammon. The implemented methods for this struct are the ones required to play a single round of Backgammon, e.g. enforcing the right player and other game rules.

Caveat: Even though you can theoretically play one Backgammon game correctly on the Game struct, it is not suggested to operate directly on this struct. To correctly apply all double cube rules, it is recommended to use the Match struct.

//        +12-11-10--9--8--7-------6--5--4--3--2--1-+
//        | X           O    |   | O              X | +-------+
//        | X           O    |   | O              X | | OFF O |
//        | X           O    |   | O                | +-------+
//        | X                |   | O                |
//        | X                |   | O                |
//        |                  |BAR|                  |
//        | O                |   | X                |
//        | O                |   | X                |
//        | O           X    |   | X                | +-------+
//        | O           X    |   | X              O | | OFF X |
//        | O           X    |   | X              O | +-------+
//        +13-14-15-16-17-18------19-20-21-22-23-24-+

Implementations

impl Game

pub fn new() -> Self

Creates a new default game.

pub fn get_state(&self) -> &GameState

Returns the current game state.

pub fn set_player(&mut self, player: Player) -> Result<(), Error>

Sets the current player.

pub fn get_player(&self) -> &Player

Returns the current player. For ended games, returns Nobody.

Trait Implementations

impl Clone for Game

fn clone(&self) -> Game

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Game

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

Formats the value using the given formatter.

impl Default for Game

fn default() -> Self

Returns the “default value” for a type.

impl Display for Game

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

Formats the value using the given formatter.

impl Move for Game

fn get_board(&self) -> BoardDisplay

Returns the current board.

fn set_checkers( &mut self, player: Player, to: Position, amount: i8, ) -> Result<(), Error>

Set a number of checkers at a given position. This method can be used to prepare a board.

Updates the game state by moving a player’s checkers to a new position on the board based on the specified amount. This function handles various scenarios such as moving checkers to specific board fields, the bar, or off the board. The method is incremental, i.e. it adds or subtracts (if negative amounts are used) the existing checkers on the respective positions.

fn empty_board(&mut self) -> Result<(), Error>

Empty the board.

fn available_moves( &self, _player: Player, ) -> Result<Vec<Vec<(Position, Position)>>, Error>

Calculates and returns all available moves for a given player based on the dice roll.

fn move_checkers( &mut self, player: Player, moves: Vec<(Position, Position)>, ) -> Result<(), Error>

Move a sequence of checkers from a given position to another position.

impl PartialEq for Game

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Roll for Game

fn roll(&mut self, player: Player) -> Result<(), Error>

Roll the two dice.

fn get_dice(&self) -> (u8, u8)

Get the current values of the dice.

fn set_dice(&mut self, player: Player, v: (u8, u8)) -> Result<(), Error>

Set the values of the dice.

fn dice_available(&self) -> &Vec<u8>

Returns the available dice values. These are the dice not yet consumed by a move.

fn dice_consumed(&self) -> bool

Return true if all dice have been consumed and no die is available for playing.

impl Stats for Game

fn pip(&self, player: Player) -> Result<u8, Error>

Returns the Pip for a player.

impl StructuralPartialEq for Game