Struct Dice 

pub struct Dice { /* private fields */ }

Represents a set of dice and rules for calculating their value when rolled

Implementations

impl Dice

pub fn new<S: AsRef<str>>(s: S) -> Self

Create a new Dice with the given dice specification. The specification is as follows: [mul*]<rolls>d<faces>[+/-offset], where

• rolls number of dice is thrown,
• these dice have faces number of faces,
• once all the dice have been thrown, offset is added to their value,
• and finally, that number is multiplied by mul.

Example

let dice = Dice::new("5*3d6+2");

pub fn roll<R: Rng>(&self, mersenne: &mut R) -> i32

Roll the dice according to their parameters. See the documentation of new() for how these parameters get used.

pub fn single_roll<R: Rng, S: AsRef<str>>(mersenne: &mut R, s: S) -> i32

Create a Dice and roll these dice once according to the given dice specification. See the documentation of new() for how this specification works. If you intend to use this dice set more than once, it’s generally better to store the Dice instance and call roll() rather than to call this method over and over.

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 Debug for Dice

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

Formats the value using the given formatter.

impl Copy for Dice