Struct hex_game::board::Board

pub struct Board {
    pub size: u16,
    // some fields omitted
}

A Hex board of a given size, with pieces placed. The maximum size is 26, due to the limitations of the standard Hex coordinate system.

Fields

size: u16

The size of the board: both width and length. The size should be no larger than 26 due to the limitations of the Hex coordinate system. It's a u16 because, when mapping coordinates to numbers, it will be converted to a u16 enough to just make that the case here.

Methods

impl Board

pub fn new(size: u16) -> Board

Initializes a blank board with given size less than or equal to 26.

pub fn place_piece(&mut self, coord: Coord, color: Color) -> bool

Places the piece at the given spot if the placement is valid (there are no other pieces and the coordinate is within range), modifying the board's state and returning true. Otherwise, does not modify the board state and returns false.

pub fn piece(&self, coord: Coord) -> HexCell

Returns a HexCell value describing the piece at the given location: Empty if no piece is there, Black if Black has a piece, or White if White has a piece. If the coordinate is out of bounds, returns Empty.

pub fn status(&self) -> GameStatus

Returns the current game status. This is updated automatically as the game progresses, so this function has basically no runtime cost.

Trait Implementations

impl Default for Board

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Board

fn clone(&self) -> Board

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Board

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

Formats the value using the given formatter.

impl Display for Board

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

Formats the value using the given formatter.