Struct cute_dnd_dice::Roll

pub struct Roll {
    pub num: u16,
    pub faces: NonZeroU16,
    pub extra: Modifier,
}

D&D Roll representation

Fields

num: u16

Number of dices

faces: NonZeroU16

Number of faces on dice

extra: Modifier

Bonus to roll

Implementations

impl Roll

pub const fn new(num: u16, faces: NonZeroU16, extra: Modifier) -> Self

pub fn from_str(text: &str) -> Result<Self, ParseError>

Attempts to parse Roll from string [num]d<faces> [+ <extra>]

pub fn min(&self) -> u16

Returns minimum possible value.

pub fn max(&self) -> u16

Returns maximum possible value.

pub fn roll_with(&self, fun: fn() -> u64) -> u16

Rolls using specified callable to generate random numbers.

fn my_random() -> u64 {
    0xff
}

let roll = cute_dnd_dice::Roll::from_str("2d20+1").unwrap();
assert_eq!(roll.roll_with(my_random), 3);

pub fn roll(&self) -> u16

Calculates roll with default random source.

It provides decent uniform distribution.

Trait Implementations

impl Debug for Roll

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

Formats the value using the given formatter.

impl Display for Roll

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

Formats the value using the given formatter.