Struct Game 

pub struct Game { /* private fields */ }

A game of Yahtzee for one or more players.

Players act in seat order, thirteen rounds each. The primitive input is deterministic dice injection — roll takes the complete five-die result, which makes replays and front ends trivial and keeps the rules free of randomness. Game::roll_with rolls for you behind the rand feature.

Illegal inputs are rejected with a GameError and leave the game unchanged, so interactive callers can simply retry.

Implementations

impl Game

pub fn new(players: usize) -> Self

Sets up a game.

Panics

Panics if players is zero.

pub const fn phase(&self) -> Phase

The current phase.

pub const fn is_over(&self) -> bool

Whether all thirteen rounds are complete.

pub const fn seat(&self) -> usize

The seat of the player to act, 0..players.

pub const fn round(&self) -> u8

The current round, 0..13.

pub const fn rolls_left(&self) -> u8

How many rolls remain this turn: 3 before the first roll, 0 after the third (when only scoring is left) and once the game is over.

pub const fn kept(&self) -> Keep

The dice held for the pending roll; empty at the start of a turn.

pub const fn dice(&self) -> Option<Dice>

The dice on the table, or None while a roll is due.

pub fn scorecard(&self, seat: usize) -> &Scorecard

One player’s card.

Panics

Panics if seat is out of range.

pub fn scorecards(&self) -> &[Scorecard]

All cards in seat order.

pub fn totals(&self) -> Vec<u16>

Every player’s grand total, in seat order.

pub const fn view(&self) -> View<'_>

The decision context for the acting player.

pub fn roll(&mut self, dice: Dice) -> Result<(), GameError>

Resolves the pending roll with a complete five-die result, which must contain the held dice.

Errors

GameError::Finished, GameError::ActionPending, or GameError::KeptNotHeld if dice dropped a held die.

pub fn roll_with<R: Rng + ?Sized>( &mut self, rng: &mut R, ) -> Result<Dice, GameError>

Rolls the unheld dice with rng and resolves the pending roll.

Errors

GameError::Finished or GameError::ActionPending.

pub fn act( &mut self, action: TurnAction, ) -> Result<Option<ScoreDelta>, GameError>

Applies the acting player’s decision: hold and reroll, or score.

Scoring returns the ScoreDelta and advances to the next seat; a reroll returns None and awaits the next roll.

Errors

GameError::Finished, GameError::RollPending, GameError::NoRerollsLeft, GameError::KeepNotInDice, or GameError::IllegalCategory; the game is left unchanged.

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 Eq for Game

impl Hash for Game

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Game

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Game