Struct Rules 

#[non_exhaustive]
pub struct Rules {
    pub knock_limit: u8,
    pub oklahoma: Option<OklahomaAce>,
    pub gin_bonus: u16,
    pub big_gin_bonus: Option<u16>,
    pub undercut_bonus: u16,
    pub undercut_on_tie: bool,
    pub box_bonus: u16,
    pub immediate_boxes: bool,
    pub game_bonus: u16,
    pub game_target: u16,
    pub shutout: Shutout,
}

The scoring rules of a game

All fields are public knobs; see the module documentation for the preset-and-adjust pattern.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

knock_limit: u8

The most deadwood a knocker may keep: 10 in every common school, and 0 plays straight gin — only a gin knock ends the round

oklahoma: Option<OklahomaAce>

Oklahoma gin: the opening upcard caps the knock limit at its deadwood value (pictures 10, aces per OklahomaAce), or None for a fixed knock_limit

No preset turns this on; enable it atop any of them. Some tables also double the hand score on a spade upcard — not modeled yet.

gin_bonus: u16

Bonus for going gin: 25 modern and palace, 20 classic

big_gin_bonus: Option<u16>

Bonus for big gin — 11 melded cards declared instead of discarding — or None where the variant is not played (classic, palace)

undercut_bonus: u16

Bonus for undercutting the knocker: 25 modern, 10 classic, 20 palace

undercut_on_tie: bool

Whether the defender undercuts on equal deadwood (all three presets say yes; some traditional tables require strictly less)

box_bonus: u16

Bonus per won hand: 25 modern, 20 classic, 10 palace

immediate_boxes: bool

When true, the box bonus is credited to the running score as each hand is won, counting toward game_target (Gin Rummy Palace); when false, boxes are tallied only at game end (traditional)

game_bonus: u16

Bonus to the winner of the game: 100 traditionally, 0 palace

game_target: u16

The score that ends the game: 100 traditionally; house games play to 150 or 250, and Gin Rummy Palace offers 10 through 500

shutout: Shutout

The shutout (blitz, schneider) rule for games whose loser never scored

Implementations

impl Rules

pub const fn new() -> Self

Modern tournament scoring, the default

pub const fn classic() -> Self

Classic scoring per Bicycle: smaller bonuses, no big gin, and a flat 100-point shutout bonus

pub const fn palace() -> Self

Gin Rummy Palace app scoring: boxes of 10 credited immediately, no game or shutout bonus

The app lets players set the target between 10 and 500; adjust game_target to taste.

pub const fn knock_limit_for(&self, initial_upcard: Card) -> u8

The knock limit in effect for a round opened by initial_upcard

Under oklahoma the upcard’s deadwood value caps knock_limit — the house limit only ever tightens, never widens; without Oklahoma it passes through unchanged. Round::knock_limit resolves this per round.

Trait Implementations

impl Clone for Rules

fn clone(&self) -> Rules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rules

impl Debug for Rules

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

Formats the value using the given formatter.

impl Default for Rules

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rules

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Rules

impl Hash for Rules

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 Rules

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Rules

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Rules