Struct randomize::ExplodingDie

#[repr(transparent)]pub struct ExplodingDie(_);

Stores data for an "exploding" 1 through N sided die.

When rolled, if a maximum value is rolled, then the die is rolled again and added to the total. Successive rolls can also trigger additional rolls on a maximum value.

Implementations

impl ExplodingDie

pub const fn new(sides: u32) -> Self

Constructs an exploding die.

Panics

If the count is 0.

pub const fn sides(self) -> i32

The number of sides of this die.

pub fn sample<G: Gen32 + ?Sized>(self, gen: &mut G) -> i32

Sample from the generator to perform an exploding roll.

Trait Implementations

impl Clone for ExplodingDie

fn clone(&self) -> ExplodingDie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ExplodingDie

impl Debug for ExplodingDie

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

Formats the value using the given formatter.

impl Eq for ExplodingDie

impl Hash for ExplodingDie

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<ExplodingDie> for ExplodingDie

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for ExplodingDie

impl StructuralPartialEq for ExplodingDie