Struct Game

pub struct Game { /* private fields */ }

The game object with the board and metadata.

Implementations

impl Game

pub fn new( width: NonZero<usize>, height: NonZero<usize>, mines: u8, duds: u8, ) -> Result<Self, Error>

Crate a new game.

Errors

Returns an Error if the grid size or amount of mines and duds is out of bounds.

pub fn rows(&self) -> impl Iterator<Item = impl Iterator<Item = View>>

Return an iterator of field views over the game board’s rows.

pub fn columns(&self) -> impl Iterator<Item = impl Iterator<Item = View>>

Return an iterator of field views over the game board’s columns.

pub fn iter(&self) -> impl Iterator<Item = View>

Return an iterator oif field views over the game board’s fields.

pub const fn mines(&self) -> u8

Returns the amount of mines in the game.

pub const fn duds(&self) -> u8

Returns the amount of duds in the game.

pub fn flags(&self) -> usize

Return the amount of flags on the game board.

pub const fn start(&self) -> Instant

Returns the instance of when the game was started.

pub const fn outcome(&self) -> Option<Outcome>

Returns the outcome, if the game has ended.

pub fn end(&self) -> Option<Instant>

Returns the instance of then the game ended, if applicable.

pub const fn is_over(&self) -> bool

Returns true if the game is over.

pub fn duration(&self) -> Duration

Returns the duration of the game.

pub fn is_won(&self) -> Option<bool>

Return the outcome of the game, if it has concluded.

Returns

• Some(true) if the game is won.
• Some(false) if the game is lost.
• None if the game is still running.

pub fn next_round(&mut self, action: Action) -> Option<State>

Play the next round.

Return Some(State) if the player did not request to abort the game, otherwise None.

Trait Implementations

impl Debug for Game

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

Formats the value using the given formatter.

impl Display for Game

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

Formats the value using the given formatter.