Struct Dice 

pub struct Dice { /* private fields */ }

A roll of exactly five six-sided dice, stored as face counts.

Order never matters in Yahtzee, so the multiset is the canonical representation: counts[f - 1] dice show face f. The five-dice invariant is enforced by every constructor, which is why scoring functions never have to handle short or long rolls.

Implementations

impl Dice

pub const fn from_faces(faces: [u8; 5]) -> Option<Self>

Builds a roll from five faces in any order.

Returns None if any face is outside 1..=6.

pub const fn from_counts(counts: [u8; 6]) -> Option<Self>

Builds a roll from face counts (counts[f - 1] dice show f).

Returns None unless the counts sum to exactly five.

pub const fn count(self, face: u8) -> u8

How many dice show face (1..=6).

Panics

Panics if face is outside 1..=6.

pub const fn counts(self) -> [u8; 6]

The face counts, indexed by face - 1.

pub const fn sum(self) -> u8

The pip total of all five dice.

pub const fn yahtzee_face(self) -> Option<u8>

The face of a five-of-a-kind, or None if this roll is not one.

pub fn faces(self) -> impl Iterator<Item = u8>

The five faces in ascending order.

pub fn keeps(self) -> impl Iterator<Item = Keep>

All distinct sub-multisets of this roll, from Keep::EMPTY to keeping everything. A roll has at most 32 keeps (all faces distinct) and as few as 6 (five of a kind).

pub const fn contains(self, keep: Keep) -> bool

Whether keep is a sub-multiset of this roll.

Trait Implementations

impl Clone for Dice

fn clone(&self) -> Dice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Dice

impl Debug for Dice

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

Formats the value using the given formatter.

impl Display for Dice

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

The five faces in ascending order: "13446".

impl Eq for Dice

impl From<Dice> for Keep

fn from(dice: Dice) -> Self

Keeping all five dice.

impl FromStr for Dice

fn from_str(s: &str) -> Result<Self, ParseDiceError>

Parses five digits 1–6, ignoring whitespace: "13446".

type Err = ParseDiceError

The associated error which can be returned from parsing.

impl Hash for Dice

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 Dice

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Dice