Struct spacebattleship::game::simple::GameSetup

pub struct GameSetup(_);

Struct used to setup the simple game.

Implementations

impl GameSetup

pub fn new() -> Self

Create a GameSetup for the game, including two players with one of each ship.

pub fn start(self) -> Result<Game, Self>

Tries to start the game. If all players are ready, returns a Game, otherwise returns self.

pub fn ready(&self) -> bool

Return true if both players are ready to start the game.

pub fn is_player_ready(&self, player: Player) -> bool

Check if the specified player is ready.

pub fn get_ships<'a>(
    &'a self,
    player: Player
) -> impl 'a + Iterator<Item = (Ship, Option<&'a Placement>)>

Get an iterator over all the ship IDs for the given player and the coordinates where that ship is placed, if any.

pub fn get_pending_ships<'a>(
    &'a self,
    player: Player
) -> impl 'a + Iterator<Item = Ship>

Get the ships for the specified player which still need to be placed.

pub fn get_placement(&self, player: Player, ship: Ship) -> Option<&Placement>

Get the the coordinates where the given ship is placed, if any.

pub fn check_placement(
    &self,
    player: Player,
    ship: Ship,
    start: Coordinate,
    dir: Orientation
) -> Result<(), CannotPlaceReason>

Check if the given placement would be valid, without attempting to actually place the ship.

pub fn place_ship(
    &mut self,
    player: Player,
    ship: Ship,
    start: Coordinate,
    dir: Orientation
) -> Result<(), CannotPlaceReason>

Try to place the specified ship at the specified position, returning an error if placement is not possible.

pub fn unplace_ship(&mut self, player: Player, ship: Ship) -> bool

Clear the placement of the specified ship. Return true if the ship was previously placed.

pub fn iter_board<'a>(
    &'a self,
    player: Player
) -> impl 'a + Iterator<Item = impl 'a + Iterator<Item = Option<Ship>>>

Get an iterator over the specified player's board. The iterator's item is another iterator that iterates over a single row.