Struct DiceRoll 

pub struct DiceRoll {
    pub number_of_dice_to_roll: u32,
    pub die: Dice,
}

This struct represents the information required to calculate the result of a dice roll given the command string. Validating the sanity of each of the parameters is left to the user. e.g. The number of dice to roll could be 0.

Fields

number_of_dice_to_roll: u32

How many dice should be rolled.

die: Dice

Which type of dice it is.

Implementations

impl DiceRoll

pub fn new(die: Dice, number_of_dice_to_roll: u32) -> Self

A convinience method for creating a DiceRoll.

Examples

This represents rolling six Boost dice

use dice_command_parser::dice_roll::{DiceRoll, Dice};

let dice_roll = DiceRoll::new(Dice::Boost, 6);

Trait Implementations

impl Clone for DiceRoll

fn clone(&self) -> DiceRoll

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiceRoll

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

Formats the value using the given formatter.

impl PartialEq for DiceRoll

fn eq(&self, other: &DiceRoll) -> 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 StructuralPartialEq for DiceRoll