Enum Keep 

pub enum Keep {
    Highest(u32),
    Lowest(u32),
}

Specifies which dice to keep from a roll.

This enum is used with RollSpec to implement advantage/disadvantage mechanics or other “keep best/worst N” scenarios.

Variants

• Highest(N): Keep the N highest dice from the roll
• Lowest(N): Keep the N lowest dice from the roll

Examples

use dice_parser::{DiceExpr, RollSpec, Keep};

// D&D 5e advantage: roll 2d20, keep highest 1
let advantage = RollSpec::new(2, 20, Some(Keep::Highest(1)));
let expr = DiceExpr::Roll(advantage);

// D&D ability scores: roll 4d6, keep highest 3
let ability_roll = RollSpec::new(4, 6, Some(Keep::Highest(3)));
let expr = DiceExpr::Roll(ability_roll);

// Keep the lowest roll (disadvantage)
let disadvantage = RollSpec::new(2, 20, Some(Keep::Lowest(1)));
let expr = DiceExpr::Roll(disadvantage);

Variants

Highest(u32)

Keep the N highest dice from the roll.

Lowest(u32)

Keep the N lowest dice from the roll.

Trait Implementations

impl Clone for Keep

fn clone(&self) -> Keep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keep

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

Formats the value using the given formatter.

impl PartialEq for Keep

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Keep

impl StructuralPartialEq for Keep